From a88e9c57676f13ebe43d165f910298fc857238f0 Mon Sep 17 00:00:00 2001 From: so0k Date: Fri, 3 Jul 2026 13:23:47 +0800 Subject: [PATCH] docs: refresh generated API reference for cdktn v0.23.4 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Regenerated from the published `cdktn@0.23.4` JSII assembly (no monorepo build — the npm tarball ships `.jsii` at its root) via `tools/documentation-generation`, against `constructs@^10.6.0` as required by 0.23.4's peer dependency. Real API changes: - `Fn` / `Fn`-generated: 7 new cross-product functions covering Terraform and OpenTofu — `base`, `cidrcontains`, `convert`, `ephemeralasnull`, `issensitive`, `templatestring`, `urldecode` (open-constructs/cdk-terrain#268) - `S3BackendConfig` (and `DataTerraformRemoteStateS3Config`): new `useLockfile` field; `dynamodbTable` deprecated in favor of it (open-constructs/cdk-terrain#234) - All construct pages: inherited `with(...mixins)` method surfaced by constructs 10.6 (previous docs were generated against the tool's stale `constructs@10.3.0` pin, which no longer satisfies 0.23.4's `^10.6.0`) Of 925 files, 705 differ only in the generator banner (`yarn` -> `pnpm` generate-docs), a byproduct of the package-manager migration in the current generator template. Navigation (`docs.json`) is unchanged: no classes/structs were added or removed, only members on existing types. Co-Authored-By: Claude Opus 4.8 --- .../csharp/classes/annotations.mdx | 2 +- .../csharp/classes/any-list-list.mdx | 2 +- .../csharp/classes/any-list-map.mdx | 2 +- .../csharp/classes/any-map-list.mdx | 2 +- .../api-reference/csharp/classes/any-map.mdx | 2 +- .../api-reference/csharp/classes/aspects.mdx | 2 +- .../csharp/classes/assertion-return.mdx | 2 +- .../csharp/classes/boolean-list-list.mdx | 2 +- .../csharp/classes/boolean-list-map.mdx | 2 +- .../csharp/classes/boolean-list.mdx | 2 +- .../csharp/classes/boolean-map-list.mdx | 2 +- .../csharp/classes/boolean-map.mdx | 2 +- .../csharp/classes/cloud-workspace.mdx | 2 +- .../csharp/classes/complex-computed-list.mdx | 2 +- .../csharp/classes/complex-list.mdx | 2 +- .../csharp/classes/complex-map.mdx | 2 +- .../csharp/classes/complex-object.mdx | 2 +- .../csharp/classes/default-token-resolver.mdx | 2 +- .../dynamic-list-terraform-iterator.mdx | 2 +- .../csharp/classes/fn-generated.mdx | 139 +++++++++++++++- content/api-reference/csharp/classes/fn.mdx | 139 +++++++++++++++- .../csharp/classes/lazy-base.mdx | 2 +- content/api-reference/csharp/classes/lazy.mdx | 2 +- .../classes/list-terraform-iterator.mdx | 2 +- .../api-reference/csharp/classes/manifest.mdx | 2 +- .../api-reference/csharp/classes/map-list.mdx | 2 +- .../csharp/classes/map-terraform-iterator.mdx | 2 +- .../csharp/classes/migrate-ids.mdx | 2 +- .../csharp/classes/named-cloud-workspace.mdx | 2 +- .../csharp/classes/named-remote-workspace.mdx | 2 +- .../csharp/classes/number-list-list.mdx | 2 +- .../csharp/classes/number-list-map.mdx | 2 +- .../csharp/classes/number-map-list.mdx | 2 +- .../csharp/classes/number-map.mdx | 2 +- content/api-reference/csharp/classes/op.mdx | 2 +- .../classes/prefixed-remote-workspaces.mdx | 2 +- .../classes/resource-terraform-iterator.mdx | 2 +- .../csharp/classes/string-concat.mdx | 2 +- .../csharp/classes/string-list-list.mdx | 2 +- .../csharp/classes/string-list-map.mdx | 2 +- .../csharp/classes/string-map-list.mdx | 2 +- .../csharp/classes/string-map-map.mdx | 2 +- .../csharp/classes/string-map.mdx | 2 +- .../classes/tagged-cloud-workspaces.mdx | 2 +- .../csharp/classes/terraform-count.mdx | 2 +- .../csharp/classes/terraform-iterator.mdx | 2 +- .../classes/terraform-resource-targets.mdx | 2 +- .../csharp/classes/terraform-self.mdx | 2 +- .../api-reference/csharp/classes/testing.mdx | 2 +- .../api-reference/csharp/classes/token.mdx | 2 +- .../csharp/classes/tokenization.mdx | 2 +- .../classes/tokenized-string-fragments.mdx | 2 +- .../csharp/classes/variable-type.mdx | 2 +- .../api-reference/csharp/constructs/app.mdx | 24 ++- .../csharp/constructs/azurerm-backend.mdx | 24 ++- .../csharp/constructs/cloud-backend.mdx | 24 ++- .../csharp/constructs/consul-backend.mdx | 24 ++- .../csharp/constructs/cos-backend.mdx | 24 ++- .../csharp/constructs/data-resource.mdx | 24 ++- .../data-terraform-remote-state-azurerm.mdx | 24 ++- .../data-terraform-remote-state-consul.mdx | 24 ++- .../data-terraform-remote-state-cos.mdx | 24 ++- .../data-terraform-remote-state-gcs.mdx | 24 ++- .../data-terraform-remote-state-http.mdx | 24 ++- .../data-terraform-remote-state-local.mdx | 24 ++- .../data-terraform-remote-state-oss.mdx | 24 ++- .../data-terraform-remote-state-pg.mdx | 24 ++- .../data-terraform-remote-state-s3.mdx | 24 ++- .../data-terraform-remote-state-swift.mdx | 24 ++- .../data-terraform-remote-state.mdx | 24 ++- .../csharp/constructs/gcs-backend.mdx | 24 ++- .../csharp/constructs/http-backend.mdx | 24 ++- .../csharp/constructs/importable-resource.mdx | 24 ++- .../csharp/constructs/local-backend.mdx | 24 ++- .../csharp/constructs/oss-backend.mdx | 24 ++- .../csharp/constructs/pg-backend.mdx | 24 ++- .../csharp/constructs/remote-backend.mdx | 24 ++- .../csharp/constructs/resource.mdx | 24 ++- .../csharp/constructs/s3-backend.mdx | 24 ++- .../csharp/constructs/swift-backend.mdx | 24 ++- .../csharp/constructs/terraform-asset.mdx | 24 ++- .../csharp/constructs/terraform-backend.mdx | 24 ++- .../constructs/terraform-data-source.mdx | 24 ++- .../csharp/constructs/terraform-element.mdx | 24 ++- .../constructs/terraform-hcl-module.mdx | 24 ++- .../csharp/constructs/terraform-local.mdx | 24 ++- .../csharp/constructs/terraform-module.mdx | 24 ++- .../csharp/constructs/terraform-output.mdx | 24 ++- .../csharp/constructs/terraform-provider.mdx | 24 ++- .../constructs/terraform-remote-state.mdx | 24 ++- .../csharp/constructs/terraform-resource.mdx | 24 ++- .../csharp/constructs/terraform-stack.mdx | 24 ++- .../csharp/constructs/terraform-variable.mdx | 24 ++- .../enums/annotation-metadata-entry-type.mdx | 2 +- .../api-reference/csharp/enums/asset-type.mdx | 2 +- .../csharp/protocols/i-any-producer.mdx | 2 +- .../csharp/protocols/i-aspect.mdx | 2 +- .../protocols/i-fragment-concatenator.mdx | 2 +- .../csharp/protocols/i-importable-config.mdx | 2 +- .../protocols/i-interpolating-parent.mdx | 2 +- .../csharp/protocols/i-list-producer.mdx | 2 +- .../csharp/protocols/i-manifest.mdx | 2 +- .../csharp/protocols/i-number-producer.mdx | 2 +- .../csharp/protocols/i-post-processor.mdx | 2 +- .../csharp/protocols/i-remote-workspace.mdx | 2 +- .../csharp/protocols/i-resolvable.mdx | 2 +- .../csharp/protocols/i-resolve-context.mdx | 2 +- .../protocols/i-resource-constructor.mdx | 2 +- .../csharp/protocols/i-resource.mdx | 2 +- .../csharp/protocols/i-scope-callback.mdx | 2 +- .../csharp/protocols/i-stack-synthesizer.mdx | 2 +- .../csharp/protocols/i-string-producer.mdx | 2 +- .../csharp/protocols/i-synthesis-session.mdx | 2 +- .../protocols/i-terraform-addressable.mdx | 2 +- .../protocols/i-terraform-dependable.mdx | 2 +- .../csharp/protocols/i-terraform-iterator.mdx | 2 +- .../csharp/protocols/i-terraform-resource.mdx | 2 +- .../csharp/protocols/i-token-mapper.mdx | 2 +- .../csharp/protocols/i-token-resolver.mdx | 2 +- .../csharp/structs/app-config.mdx | 2 +- .../csharp/structs/azurerm-backend-config.mdx | 2 +- .../csharp/structs/cloud-backend-config.mdx | 2 +- .../csharp/structs/consul-backend-config.mdx | 2 +- .../structs/cos-backend-assume-role.mdx | 2 +- .../csharp/structs/cos-backend-config.mdx | 2 +- .../csharp/structs/data-config.mdx | 2 +- ...-terraform-remote-state-azurerm-config.mdx | 2 +- .../data-terraform-remote-state-config.mdx | 2 +- ...a-terraform-remote-state-consul-config.mdx | 2 +- ...data-terraform-remote-state-cos-config.mdx | 2 +- ...data-terraform-remote-state-gcs-config.mdx | 2 +- ...ata-terraform-remote-state-http-config.mdx | 2 +- ...ta-terraform-remote-state-local-config.mdx | 2 +- ...data-terraform-remote-state-oss-config.mdx | 2 +- .../data-terraform-remote-state-pg-config.mdx | 2 +- ...a-terraform-remote-state-remote-config.mdx | 2 +- .../data-terraform-remote-state-s3-config.mdx | 27 ++- ...ta-terraform-remote-state-swift-config.mdx | 2 +- .../csharp/structs/encoding-options.mdx | 2 +- .../csharp/structs/file-provisioner.mdx | 2 +- .../csharp/structs/gcs-backend-config.mdx | 2 +- .../csharp/structs/http-backend-config.mdx | 2 +- .../csharp/structs/lazy-any-value-options.mdx | 2 +- .../structs/lazy-list-value-options.mdx | 2 +- .../structs/lazy-string-value-options.mdx | 2 +- .../csharp/structs/local-backend-config.mdx | 2 +- .../csharp/structs/local-exec-provisioner.mdx | 2 +- .../csharp/structs/oss-assume-role.mdx | 2 +- .../csharp/structs/oss-backend-config.mdx | 2 +- .../csharp/structs/pg-backend-config.mdx | 2 +- .../csharp/structs/postcondition.mdx | 2 +- .../csharp/structs/precondition.mdx | 2 +- .../csharp/structs/remote-backend-config.mdx | 2 +- .../structs/remote-exec-provisioner.mdx | 2 +- .../csharp/structs/resolve-options.mdx | 2 +- .../structs/s3-backend-assume-role-config.mdx | 2 +- ...d-assume-role-with-web-identity-config.mdx | 2 +- .../csharp/structs/s3-backend-config.mdx | 27 ++- .../structs/s3-backend-endpoint-config.mdx | 2 +- .../structs/ssh-provisioner-connection.mdx | 2 +- .../csharp/structs/stack-annotation.mdx | 2 +- .../csharp/structs/stack-manifest.mdx | 2 +- .../csharp/structs/swift-backend-config.mdx | 2 +- .../csharp/structs/terraform-asset-config.mdx | 2 +- .../csharp/structs/terraform-condition.mdx | 2 +- .../csharp/structs/terraform-constructor.mdx | 2 +- .../structs/terraform-element-metadata.mdx | 2 +- .../structs/terraform-hcl-module-config.mdx | 2 +- .../structs/terraform-meta-arguments.mdx | 2 +- .../structs/terraform-module-config.mdx | 2 +- .../structs/terraform-module-provider.mdx | 2 +- .../structs/terraform-module-user-config.mdx | 2 +- .../structs/terraform-output-config.mdx | 2 +- .../structs/terraform-provider-config.mdx | 2 +- .../terraform-provider-generator-metadata.mdx | 2 +- .../structs/terraform-resource-config.mdx | 2 +- .../structs/terraform-resource-import.mdx | 2 +- .../structs/terraform-resource-lifecycle.mdx | 2 +- .../structs/terraform-resource-move-by-id.mdx | 2 +- .../terraform-resource-move-by-target.mdx | 2 +- .../structs/terraform-stack-metadata.mdx | 2 +- .../structs/terraform-variable-config.mdx | 2 +- .../terraform-variable-validation-config.mdx | 2 +- .../csharp/structs/testing-app-config.mdx | 2 +- .../structs/winrm-provisioner-connection.mdx | 2 +- .../api-reference/go/classes/annotations.mdx | 2 +- .../go/classes/any-list-list.mdx | 2 +- .../api-reference/go/classes/any-list-map.mdx | 2 +- .../api-reference/go/classes/any-map-list.mdx | 2 +- content/api-reference/go/classes/any-map.mdx | 2 +- content/api-reference/go/classes/aspects.mdx | 2 +- .../go/classes/assertion-return.mdx | 2 +- .../go/classes/boolean-list-list.mdx | 2 +- .../go/classes/boolean-list-map.mdx | 2 +- .../api-reference/go/classes/boolean-list.mdx | 2 +- .../go/classes/boolean-map-list.mdx | 2 +- .../api-reference/go/classes/boolean-map.mdx | 2 +- .../go/classes/cloud-workspace.mdx | 2 +- .../go/classes/complex-computed-list.mdx | 2 +- .../api-reference/go/classes/complex-list.mdx | 2 +- .../api-reference/go/classes/complex-map.mdx | 2 +- .../go/classes/complex-object.mdx | 2 +- .../go/classes/default-token-resolver.mdx | 2 +- .../dynamic-list-terraform-iterator.mdx | 2 +- .../api-reference/go/classes/fn-generated.mdx | 143 +++++++++++++++- content/api-reference/go/classes/fn.mdx | 143 +++++++++++++++- .../api-reference/go/classes/lazy-base.mdx | 2 +- content/api-reference/go/classes/lazy.mdx | 2 +- .../go/classes/list-terraform-iterator.mdx | 2 +- content/api-reference/go/classes/manifest.mdx | 2 +- content/api-reference/go/classes/map-list.mdx | 2 +- .../go/classes/map-terraform-iterator.mdx | 2 +- .../api-reference/go/classes/migrate-ids.mdx | 2 +- .../go/classes/named-cloud-workspace.mdx | 2 +- .../go/classes/named-remote-workspace.mdx | 2 +- .../go/classes/number-list-list.mdx | 2 +- .../go/classes/number-list-map.mdx | 2 +- .../go/classes/number-map-list.mdx | 2 +- .../api-reference/go/classes/number-map.mdx | 2 +- content/api-reference/go/classes/op.mdx | 2 +- .../go/classes/prefixed-remote-workspaces.mdx | 2 +- .../classes/resource-terraform-iterator.mdx | 2 +- .../go/classes/string-concat.mdx | 2 +- .../go/classes/string-list-list.mdx | 2 +- .../go/classes/string-list-map.mdx | 2 +- .../go/classes/string-map-list.mdx | 2 +- .../go/classes/string-map-map.mdx | 2 +- .../api-reference/go/classes/string-map.mdx | 2 +- .../go/classes/tagged-cloud-workspaces.mdx | 2 +- .../go/classes/terraform-count.mdx | 2 +- .../go/classes/terraform-iterator.mdx | 2 +- .../go/classes/terraform-resource-targets.mdx | 2 +- .../go/classes/terraform-self.mdx | 2 +- content/api-reference/go/classes/testing.mdx | 2 +- content/api-reference/go/classes/token.mdx | 2 +- .../api-reference/go/classes/tokenization.mdx | 2 +- .../go/classes/tokenized-string-fragments.mdx | 2 +- .../go/classes/variable-type.mdx | 2 +- content/api-reference/go/constructs/app.mdx | 24 ++- .../go/constructs/azurerm-backend.mdx | 24 ++- .../go/constructs/cloud-backend.mdx | 24 ++- .../go/constructs/consul-backend.mdx | 24 ++- .../go/constructs/cos-backend.mdx | 24 ++- .../go/constructs/data-resource.mdx | 24 ++- .../data-terraform-remote-state-azurerm.mdx | 24 ++- .../data-terraform-remote-state-consul.mdx | 24 ++- .../data-terraform-remote-state-cos.mdx | 24 ++- .../data-terraform-remote-state-gcs.mdx | 24 ++- .../data-terraform-remote-state-http.mdx | 24 ++- .../data-terraform-remote-state-local.mdx | 24 ++- .../data-terraform-remote-state-oss.mdx | 24 ++- .../data-terraform-remote-state-pg.mdx | 24 ++- .../data-terraform-remote-state-s3.mdx | 24 ++- .../data-terraform-remote-state-swift.mdx | 24 ++- .../data-terraform-remote-state.mdx | 24 ++- .../go/constructs/gcs-backend.mdx | 24 ++- .../go/constructs/http-backend.mdx | 24 ++- .../go/constructs/importable-resource.mdx | 24 ++- .../go/constructs/local-backend.mdx | 24 ++- .../go/constructs/oss-backend.mdx | 24 ++- .../go/constructs/pg-backend.mdx | 24 ++- .../go/constructs/remote-backend.mdx | 24 ++- .../api-reference/go/constructs/resource.mdx | 24 ++- .../go/constructs/s3-backend.mdx | 24 ++- .../go/constructs/swift-backend.mdx | 24 ++- .../go/constructs/terraform-asset.mdx | 24 ++- .../go/constructs/terraform-backend.mdx | 24 ++- .../go/constructs/terraform-data-source.mdx | 24 ++- .../go/constructs/terraform-element.mdx | 24 ++- .../go/constructs/terraform-hcl-module.mdx | 24 ++- .../go/constructs/terraform-local.mdx | 24 ++- .../go/constructs/terraform-module.mdx | 24 ++- .../go/constructs/terraform-output.mdx | 24 ++- .../go/constructs/terraform-provider.mdx | 24 ++- .../go/constructs/terraform-remote-state.mdx | 24 ++- .../go/constructs/terraform-resource.mdx | 24 ++- .../go/constructs/terraform-stack.mdx | 24 ++- .../go/constructs/terraform-variable.mdx | 24 ++- .../enums/annotation-metadata-entry-type.mdx | 2 +- content/api-reference/go/enums/asset-type.mdx | 2 +- .../go/protocols/i-any-producer.mdx | 2 +- .../api-reference/go/protocols/i-aspect.mdx | 2 +- .../go/protocols/i-fragment-concatenator.mdx | 2 +- .../go/protocols/i-importable-config.mdx | 2 +- .../go/protocols/i-interpolating-parent.mdx | 2 +- .../go/protocols/i-list-producer.mdx | 2 +- .../api-reference/go/protocols/i-manifest.mdx | 2 +- .../go/protocols/i-number-producer.mdx | 2 +- .../go/protocols/i-post-processor.mdx | 2 +- .../go/protocols/i-remote-workspace.mdx | 2 +- .../go/protocols/i-resolvable.mdx | 2 +- .../go/protocols/i-resolve-context.mdx | 2 +- .../go/protocols/i-resource-constructor.mdx | 2 +- .../api-reference/go/protocols/i-resource.mdx | 2 +- .../go/protocols/i-scope-callback.mdx | 2 +- .../go/protocols/i-stack-synthesizer.mdx | 2 +- .../go/protocols/i-string-producer.mdx | 2 +- .../go/protocols/i-synthesis-session.mdx | 2 +- .../go/protocols/i-terraform-addressable.mdx | 2 +- .../go/protocols/i-terraform-dependable.mdx | 2 +- .../go/protocols/i-terraform-iterator.mdx | 2 +- .../go/protocols/i-terraform-resource.mdx | 2 +- .../go/protocols/i-token-mapper.mdx | 2 +- .../go/protocols/i-token-resolver.mdx | 2 +- .../api-reference/go/structs/app-config.mdx | 2 +- .../go/structs/azurerm-backend-config.mdx | 2 +- .../go/structs/cloud-backend-config.mdx | 2 +- .../go/structs/consul-backend-config.mdx | 2 +- .../go/structs/cos-backend-assume-role.mdx | 2 +- .../go/structs/cos-backend-config.mdx | 2 +- .../api-reference/go/structs/data-config.mdx | 2 +- ...-terraform-remote-state-azurerm-config.mdx | 2 +- .../data-terraform-remote-state-config.mdx | 2 +- ...a-terraform-remote-state-consul-config.mdx | 2 +- ...data-terraform-remote-state-cos-config.mdx | 2 +- ...data-terraform-remote-state-gcs-config.mdx | 2 +- ...ata-terraform-remote-state-http-config.mdx | 2 +- ...ta-terraform-remote-state-local-config.mdx | 2 +- ...data-terraform-remote-state-oss-config.mdx | 2 +- .../data-terraform-remote-state-pg-config.mdx | 2 +- ...a-terraform-remote-state-remote-config.mdx | 2 +- .../data-terraform-remote-state-s3-config.mdx | 27 ++- ...ta-terraform-remote-state-swift-config.mdx | 2 +- .../go/structs/encoding-options.mdx | 2 +- .../go/structs/file-provisioner.mdx | 2 +- .../go/structs/gcs-backend-config.mdx | 2 +- .../go/structs/http-backend-config.mdx | 2 +- .../go/structs/lazy-any-value-options.mdx | 2 +- .../go/structs/lazy-list-value-options.mdx | 2 +- .../go/structs/lazy-string-value-options.mdx | 2 +- .../go/structs/local-backend-config.mdx | 2 +- .../go/structs/local-exec-provisioner.mdx | 2 +- .../go/structs/oss-assume-role.mdx | 2 +- .../go/structs/oss-backend-config.mdx | 2 +- .../go/structs/pg-backend-config.mdx | 2 +- .../go/structs/postcondition.mdx | 2 +- .../api-reference/go/structs/precondition.mdx | 2 +- .../go/structs/remote-backend-config.mdx | 2 +- .../go/structs/remote-exec-provisioner.mdx | 2 +- .../go/structs/resolve-options.mdx | 2 +- .../structs/s3-backend-assume-role-config.mdx | 2 +- ...d-assume-role-with-web-identity-config.mdx | 2 +- .../go/structs/s3-backend-config.mdx | 27 ++- .../go/structs/s3-backend-endpoint-config.mdx | 2 +- .../go/structs/ssh-provisioner-connection.mdx | 2 +- .../go/structs/stack-annotation.mdx | 2 +- .../go/structs/stack-manifest.mdx | 2 +- .../go/structs/swift-backend-config.mdx | 2 +- .../go/structs/terraform-asset-config.mdx | 2 +- .../go/structs/terraform-condition.mdx | 2 +- .../go/structs/terraform-constructor.mdx | 2 +- .../go/structs/terraform-element-metadata.mdx | 2 +- .../structs/terraform-hcl-module-config.mdx | 2 +- .../go/structs/terraform-meta-arguments.mdx | 2 +- .../go/structs/terraform-module-config.mdx | 2 +- .../go/structs/terraform-module-provider.mdx | 2 +- .../structs/terraform-module-user-config.mdx | 2 +- .../go/structs/terraform-output-config.mdx | 2 +- .../go/structs/terraform-provider-config.mdx | 2 +- .../terraform-provider-generator-metadata.mdx | 2 +- .../go/structs/terraform-resource-config.mdx | 2 +- .../go/structs/terraform-resource-import.mdx | 2 +- .../structs/terraform-resource-lifecycle.mdx | 2 +- .../structs/terraform-resource-move-by-id.mdx | 2 +- .../terraform-resource-move-by-target.mdx | 2 +- .../go/structs/terraform-stack-metadata.mdx | 2 +- .../go/structs/terraform-variable-config.mdx | 2 +- .../terraform-variable-validation-config.mdx | 2 +- .../go/structs/testing-app-config.mdx | 2 +- .../structs/winrm-provisioner-connection.mdx | 2 +- .../java/classes/annotations.mdx | 2 +- .../java/classes/any-list-list.mdx | 2 +- .../java/classes/any-list-map.mdx | 2 +- .../java/classes/any-map-list.mdx | 2 +- .../api-reference/java/classes/any-map.mdx | 2 +- .../api-reference/java/classes/aspects.mdx | 2 +- .../java/classes/assertion-return.mdx | 2 +- .../java/classes/boolean-list-list.mdx | 2 +- .../java/classes/boolean-list-map.mdx | 2 +- .../java/classes/boolean-list.mdx | 2 +- .../java/classes/boolean-map-list.mdx | 2 +- .../java/classes/boolean-map.mdx | 2 +- .../java/classes/cloud-workspace.mdx | 2 +- .../java/classes/complex-computed-list.mdx | 2 +- .../java/classes/complex-list.mdx | 2 +- .../java/classes/complex-map.mdx | 2 +- .../java/classes/complex-object.mdx | 2 +- .../java/classes/default-token-resolver.mdx | 2 +- .../dynamic-list-terraform-iterator.mdx | 2 +- .../java/classes/fn-generated.mdx | 139 +++++++++++++++- content/api-reference/java/classes/fn.mdx | 139 +++++++++++++++- .../api-reference/java/classes/lazy-base.mdx | 2 +- content/api-reference/java/classes/lazy.mdx | 2 +- .../java/classes/list-terraform-iterator.mdx | 2 +- .../api-reference/java/classes/manifest.mdx | 2 +- .../api-reference/java/classes/map-list.mdx | 2 +- .../java/classes/map-terraform-iterator.mdx | 2 +- .../java/classes/migrate-ids.mdx | 2 +- .../java/classes/named-cloud-workspace.mdx | 2 +- .../java/classes/named-remote-workspace.mdx | 2 +- .../java/classes/number-list-list.mdx | 2 +- .../java/classes/number-list-map.mdx | 2 +- .../java/classes/number-map-list.mdx | 2 +- .../api-reference/java/classes/number-map.mdx | 2 +- content/api-reference/java/classes/op.mdx | 2 +- .../classes/prefixed-remote-workspaces.mdx | 2 +- .../classes/resource-terraform-iterator.mdx | 2 +- .../java/classes/string-concat.mdx | 2 +- .../java/classes/string-list-list.mdx | 2 +- .../java/classes/string-list-map.mdx | 2 +- .../java/classes/string-map-list.mdx | 2 +- .../java/classes/string-map-map.mdx | 2 +- .../api-reference/java/classes/string-map.mdx | 2 +- .../java/classes/tagged-cloud-workspaces.mdx | 2 +- .../java/classes/terraform-count.mdx | 2 +- .../java/classes/terraform-iterator.mdx | 2 +- .../classes/terraform-resource-targets.mdx | 2 +- .../java/classes/terraform-self.mdx | 2 +- .../api-reference/java/classes/testing.mdx | 2 +- content/api-reference/java/classes/token.mdx | 2 +- .../java/classes/tokenization.mdx | 2 +- .../classes/tokenized-string-fragments.mdx | 2 +- .../java/classes/variable-type.mdx | 2 +- content/api-reference/java/constructs/app.mdx | 24 ++- .../java/constructs/azurerm-backend.mdx | 24 ++- .../java/constructs/cloud-backend.mdx | 24 ++- .../java/constructs/consul-backend.mdx | 24 ++- .../java/constructs/cos-backend.mdx | 24 ++- .../java/constructs/data-resource.mdx | 24 ++- .../data-terraform-remote-state-azurerm.mdx | 24 ++- .../data-terraform-remote-state-consul.mdx | 24 ++- .../data-terraform-remote-state-cos.mdx | 24 ++- .../data-terraform-remote-state-gcs.mdx | 24 ++- .../data-terraform-remote-state-http.mdx | 24 ++- .../data-terraform-remote-state-local.mdx | 24 ++- .../data-terraform-remote-state-oss.mdx | 24 ++- .../data-terraform-remote-state-pg.mdx | 24 ++- .../data-terraform-remote-state-s3.mdx | 45 ++++- .../data-terraform-remote-state-swift.mdx | 24 ++- .../data-terraform-remote-state.mdx | 24 ++- .../java/constructs/gcs-backend.mdx | 24 ++- .../java/constructs/http-backend.mdx | 24 ++- .../java/constructs/importable-resource.mdx | 24 ++- .../java/constructs/local-backend.mdx | 24 ++- .../java/constructs/oss-backend.mdx | 24 ++- .../java/constructs/pg-backend.mdx | 24 ++- .../java/constructs/remote-backend.mdx | 24 ++- .../java/constructs/resource.mdx | 24 ++- .../java/constructs/s3-backend.mdx | 45 ++++- .../java/constructs/swift-backend.mdx | 24 ++- .../java/constructs/terraform-asset.mdx | 24 ++- .../java/constructs/terraform-backend.mdx | 24 ++- .../java/constructs/terraform-data-source.mdx | 24 ++- .../java/constructs/terraform-element.mdx | 24 ++- .../java/constructs/terraform-hcl-module.mdx | 24 ++- .../java/constructs/terraform-local.mdx | 24 ++- .../java/constructs/terraform-module.mdx | 24 ++- .../java/constructs/terraform-output.mdx | 24 ++- .../java/constructs/terraform-provider.mdx | 24 ++- .../constructs/terraform-remote-state.mdx | 24 ++- .../java/constructs/terraform-resource.mdx | 24 ++- .../java/constructs/terraform-stack.mdx | 24 ++- .../java/constructs/terraform-variable.mdx | 24 ++- .../enums/annotation-metadata-entry-type.mdx | 2 +- .../api-reference/java/enums/asset-type.mdx | 2 +- .../java/protocols/i-any-producer.mdx | 2 +- .../api-reference/java/protocols/i-aspect.mdx | 2 +- .../protocols/i-fragment-concatenator.mdx | 2 +- .../java/protocols/i-importable-config.mdx | 2 +- .../java/protocols/i-interpolating-parent.mdx | 2 +- .../java/protocols/i-list-producer.mdx | 2 +- .../java/protocols/i-manifest.mdx | 2 +- .../java/protocols/i-number-producer.mdx | 2 +- .../java/protocols/i-post-processor.mdx | 2 +- .../java/protocols/i-remote-workspace.mdx | 2 +- .../java/protocols/i-resolvable.mdx | 2 +- .../java/protocols/i-resolve-context.mdx | 2 +- .../java/protocols/i-resource-constructor.mdx | 2 +- .../java/protocols/i-resource.mdx | 2 +- .../java/protocols/i-scope-callback.mdx | 2 +- .../java/protocols/i-stack-synthesizer.mdx | 2 +- .../java/protocols/i-string-producer.mdx | 2 +- .../java/protocols/i-synthesis-session.mdx | 2 +- .../protocols/i-terraform-addressable.mdx | 2 +- .../java/protocols/i-terraform-dependable.mdx | 2 +- .../java/protocols/i-terraform-iterator.mdx | 2 +- .../java/protocols/i-terraform-resource.mdx | 2 +- .../java/protocols/i-token-mapper.mdx | 2 +- .../java/protocols/i-token-resolver.mdx | 2 +- .../api-reference/java/structs/app-config.mdx | 2 +- .../java/structs/azurerm-backend-config.mdx | 2 +- .../java/structs/cloud-backend-config.mdx | 2 +- .../java/structs/consul-backend-config.mdx | 2 +- .../java/structs/cos-backend-assume-role.mdx | 2 +- .../java/structs/cos-backend-config.mdx | 2 +- .../java/structs/data-config.mdx | 2 +- ...-terraform-remote-state-azurerm-config.mdx | 2 +- .../data-terraform-remote-state-config.mdx | 2 +- ...a-terraform-remote-state-consul-config.mdx | 2 +- ...data-terraform-remote-state-cos-config.mdx | 2 +- ...data-terraform-remote-state-gcs-config.mdx | 2 +- ...ata-terraform-remote-state-http-config.mdx | 2 +- ...ta-terraform-remote-state-local-config.mdx | 2 +- ...data-terraform-remote-state-oss-config.mdx | 2 +- .../data-terraform-remote-state-pg-config.mdx | 2 +- ...a-terraform-remote-state-remote-config.mdx | 2 +- .../data-terraform-remote-state-s3-config.mdx | 27 ++- ...ta-terraform-remote-state-swift-config.mdx | 2 +- .../java/structs/encoding-options.mdx | 2 +- .../java/structs/file-provisioner.mdx | 2 +- .../java/structs/gcs-backend-config.mdx | 2 +- .../java/structs/http-backend-config.mdx | 2 +- .../java/structs/lazy-any-value-options.mdx | 2 +- .../java/structs/lazy-list-value-options.mdx | 2 +- .../structs/lazy-string-value-options.mdx | 2 +- .../java/structs/local-backend-config.mdx | 2 +- .../java/structs/local-exec-provisioner.mdx | 2 +- .../java/structs/oss-assume-role.mdx | 2 +- .../java/structs/oss-backend-config.mdx | 2 +- .../java/structs/pg-backend-config.mdx | 2 +- .../java/structs/postcondition.mdx | 2 +- .../java/structs/precondition.mdx | 2 +- .../java/structs/remote-backend-config.mdx | 2 +- .../java/structs/remote-exec-provisioner.mdx | 2 +- .../java/structs/resolve-options.mdx | 2 +- .../structs/s3-backend-assume-role-config.mdx | 2 +- ...d-assume-role-with-web-identity-config.mdx | 2 +- .../java/structs/s3-backend-config.mdx | 27 ++- .../structs/s3-backend-endpoint-config.mdx | 2 +- .../structs/ssh-provisioner-connection.mdx | 2 +- .../java/structs/stack-annotation.mdx | 2 +- .../java/structs/stack-manifest.mdx | 2 +- .../java/structs/swift-backend-config.mdx | 2 +- .../java/structs/terraform-asset-config.mdx | 2 +- .../java/structs/terraform-condition.mdx | 2 +- .../java/structs/terraform-constructor.mdx | 2 +- .../structs/terraform-element-metadata.mdx | 2 +- .../structs/terraform-hcl-module-config.mdx | 2 +- .../java/structs/terraform-meta-arguments.mdx | 2 +- .../java/structs/terraform-module-config.mdx | 2 +- .../structs/terraform-module-provider.mdx | 2 +- .../structs/terraform-module-user-config.mdx | 2 +- .../java/structs/terraform-output-config.mdx | 2 +- .../structs/terraform-provider-config.mdx | 2 +- .../terraform-provider-generator-metadata.mdx | 2 +- .../structs/terraform-resource-config.mdx | 2 +- .../structs/terraform-resource-import.mdx | 2 +- .../structs/terraform-resource-lifecycle.mdx | 2 +- .../structs/terraform-resource-move-by-id.mdx | 2 +- .../terraform-resource-move-by-target.mdx | 2 +- .../java/structs/terraform-stack-metadata.mdx | 2 +- .../structs/terraform-variable-config.mdx | 2 +- .../terraform-variable-validation-config.mdx | 2 +- .../java/structs/testing-app-config.mdx | 2 +- .../structs/winrm-provisioner-connection.mdx | 2 +- .../python/classes/annotations.mdx | 2 +- .../python/classes/any-list-list.mdx | 2 +- .../python/classes/any-list-map.mdx | 2 +- .../python/classes/any-map-list.mdx | 2 +- .../api-reference/python/classes/any-map.mdx | 2 +- .../api-reference/python/classes/aspects.mdx | 2 +- .../python/classes/assertion-return.mdx | 2 +- .../python/classes/boolean-list-list.mdx | 2 +- .../python/classes/boolean-list-map.mdx | 2 +- .../python/classes/boolean-list.mdx | 2 +- .../python/classes/boolean-map-list.mdx | 2 +- .../python/classes/boolean-map.mdx | 2 +- .../python/classes/cloud-workspace.mdx | 2 +- .../python/classes/complex-computed-list.mdx | 2 +- .../python/classes/complex-list.mdx | 2 +- .../python/classes/complex-map.mdx | 2 +- .../python/classes/complex-object.mdx | 2 +- .../python/classes/default-token-resolver.mdx | 2 +- .../dynamic-list-terraform-iterator.mdx | 2 +- .../python/classes/fn-generated.mdx | 156 +++++++++++++++++- content/api-reference/python/classes/fn.mdx | 156 +++++++++++++++++- .../python/classes/lazy-base.mdx | 2 +- content/api-reference/python/classes/lazy.mdx | 2 +- .../classes/list-terraform-iterator.mdx | 2 +- .../api-reference/python/classes/manifest.mdx | 2 +- .../api-reference/python/classes/map-list.mdx | 2 +- .../python/classes/map-terraform-iterator.mdx | 2 +- .../python/classes/migrate-ids.mdx | 2 +- .../python/classes/named-cloud-workspace.mdx | 2 +- .../python/classes/named-remote-workspace.mdx | 2 +- .../python/classes/number-list-list.mdx | 2 +- .../python/classes/number-list-map.mdx | 2 +- .../python/classes/number-map-list.mdx | 2 +- .../python/classes/number-map.mdx | 2 +- content/api-reference/python/classes/op.mdx | 2 +- .../classes/prefixed-remote-workspaces.mdx | 2 +- .../classes/resource-terraform-iterator.mdx | 2 +- .../python/classes/string-concat.mdx | 2 +- .../python/classes/string-list-list.mdx | 2 +- .../python/classes/string-list-map.mdx | 2 +- .../python/classes/string-map-list.mdx | 2 +- .../python/classes/string-map-map.mdx | 2 +- .../python/classes/string-map.mdx | 2 +- .../classes/tagged-cloud-workspaces.mdx | 2 +- .../python/classes/terraform-count.mdx | 2 +- .../python/classes/terraform-iterator.mdx | 2 +- .../classes/terraform-resource-targets.mdx | 2 +- .../python/classes/terraform-self.mdx | 2 +- .../api-reference/python/classes/testing.mdx | 2 +- .../api-reference/python/classes/token.mdx | 2 +- .../python/classes/tokenization.mdx | 2 +- .../classes/tokenized-string-fragments.mdx | 2 +- .../python/classes/variable-type.mdx | 2 +- .../api-reference/python/constructs/app.mdx | 26 ++- .../python/constructs/azurerm-backend.mdx | 26 ++- .../python/constructs/cloud-backend.mdx | 26 ++- .../python/constructs/consul-backend.mdx | 26 ++- .../python/constructs/cos-backend.mdx | 26 ++- .../python/constructs/data-resource.mdx | 26 ++- .../data-terraform-remote-state-azurerm.mdx | 26 ++- .../data-terraform-remote-state-consul.mdx | 26 ++- .../data-terraform-remote-state-cos.mdx | 26 ++- .../data-terraform-remote-state-gcs.mdx | 26 ++- .../data-terraform-remote-state-http.mdx | 26 ++- .../data-terraform-remote-state-local.mdx | 26 ++- .../data-terraform-remote-state-oss.mdx | 26 ++- .../data-terraform-remote-state-pg.mdx | 26 ++- .../data-terraform-remote-state-s3.mdx | 47 +++++- .../data-terraform-remote-state-swift.mdx | 26 ++- .../data-terraform-remote-state.mdx | 26 ++- .../python/constructs/gcs-backend.mdx | 26 ++- .../python/constructs/http-backend.mdx | 26 ++- .../python/constructs/importable-resource.mdx | 26 ++- .../python/constructs/local-backend.mdx | 26 ++- .../python/constructs/oss-backend.mdx | 26 ++- .../python/constructs/pg-backend.mdx | 26 ++- .../python/constructs/remote-backend.mdx | 26 ++- .../python/constructs/resource.mdx | 26 ++- .../python/constructs/s3-backend.mdx | 47 +++++- .../python/constructs/swift-backend.mdx | 26 ++- .../python/constructs/terraform-asset.mdx | 26 ++- .../python/constructs/terraform-backend.mdx | 26 ++- .../constructs/terraform-data-source.mdx | 26 ++- .../python/constructs/terraform-element.mdx | 26 ++- .../constructs/terraform-hcl-module.mdx | 26 ++- .../python/constructs/terraform-local.mdx | 26 ++- .../python/constructs/terraform-module.mdx | 26 ++- .../python/constructs/terraform-output.mdx | 26 ++- .../python/constructs/terraform-provider.mdx | 26 ++- .../constructs/terraform-remote-state.mdx | 26 ++- .../python/constructs/terraform-resource.mdx | 26 ++- .../python/constructs/terraform-stack.mdx | 26 ++- .../python/constructs/terraform-variable.mdx | 26 ++- .../enums/annotation-metadata-entry-type.mdx | 2 +- .../api-reference/python/enums/asset-type.mdx | 2 +- .../python/protocols/i-any-producer.mdx | 2 +- .../python/protocols/i-aspect.mdx | 2 +- .../protocols/i-fragment-concatenator.mdx | 2 +- .../python/protocols/i-importable-config.mdx | 2 +- .../protocols/i-interpolating-parent.mdx | 2 +- .../python/protocols/i-list-producer.mdx | 2 +- .../python/protocols/i-manifest.mdx | 2 +- .../python/protocols/i-number-producer.mdx | 2 +- .../python/protocols/i-post-processor.mdx | 2 +- .../python/protocols/i-remote-workspace.mdx | 2 +- .../python/protocols/i-resolvable.mdx | 2 +- .../python/protocols/i-resolve-context.mdx | 2 +- .../protocols/i-resource-constructor.mdx | 2 +- .../python/protocols/i-resource.mdx | 2 +- .../python/protocols/i-scope-callback.mdx | 2 +- .../python/protocols/i-stack-synthesizer.mdx | 2 +- .../python/protocols/i-string-producer.mdx | 2 +- .../python/protocols/i-synthesis-session.mdx | 2 +- .../protocols/i-terraform-addressable.mdx | 2 +- .../protocols/i-terraform-dependable.mdx | 2 +- .../python/protocols/i-terraform-iterator.mdx | 2 +- .../python/protocols/i-terraform-resource.mdx | 2 +- .../python/protocols/i-token-mapper.mdx | 2 +- .../python/protocols/i-token-resolver.mdx | 2 +- .../python/structs/app-config.mdx | 2 +- .../python/structs/azurerm-backend-config.mdx | 2 +- .../python/structs/cloud-backend-config.mdx | 2 +- .../python/structs/consul-backend-config.mdx | 2 +- .../structs/cos-backend-assume-role.mdx | 2 +- .../python/structs/cos-backend-config.mdx | 2 +- .../python/structs/data-config.mdx | 2 +- ...-terraform-remote-state-azurerm-config.mdx | 2 +- .../data-terraform-remote-state-config.mdx | 2 +- ...a-terraform-remote-state-consul-config.mdx | 2 +- ...data-terraform-remote-state-cos-config.mdx | 2 +- ...data-terraform-remote-state-gcs-config.mdx | 2 +- ...ata-terraform-remote-state-http-config.mdx | 2 +- ...ta-terraform-remote-state-local-config.mdx | 2 +- ...data-terraform-remote-state-oss-config.mdx | 2 +- .../data-terraform-remote-state-pg-config.mdx | 2 +- ...a-terraform-remote-state-remote-config.mdx | 2 +- .../data-terraform-remote-state-s3-config.mdx | 27 ++- ...ta-terraform-remote-state-swift-config.mdx | 2 +- .../python/structs/encoding-options.mdx | 2 +- .../python/structs/file-provisioner.mdx | 2 +- .../python/structs/gcs-backend-config.mdx | 2 +- .../python/structs/http-backend-config.mdx | 2 +- .../python/structs/lazy-any-value-options.mdx | 2 +- .../structs/lazy-list-value-options.mdx | 2 +- .../structs/lazy-string-value-options.mdx | 2 +- .../python/structs/local-backend-config.mdx | 2 +- .../python/structs/local-exec-provisioner.mdx | 2 +- .../python/structs/oss-assume-role.mdx | 2 +- .../python/structs/oss-backend-config.mdx | 2 +- .../python/structs/pg-backend-config.mdx | 2 +- .../python/structs/postcondition.mdx | 2 +- .../python/structs/precondition.mdx | 2 +- .../python/structs/remote-backend-config.mdx | 2 +- .../structs/remote-exec-provisioner.mdx | 2 +- .../python/structs/resolve-options.mdx | 2 +- .../structs/s3-backend-assume-role-config.mdx | 2 +- ...d-assume-role-with-web-identity-config.mdx | 2 +- .../python/structs/s3-backend-config.mdx | 27 ++- .../structs/s3-backend-endpoint-config.mdx | 2 +- .../structs/ssh-provisioner-connection.mdx | 2 +- .../python/structs/stack-annotation.mdx | 2 +- .../python/structs/stack-manifest.mdx | 2 +- .../python/structs/swift-backend-config.mdx | 2 +- .../python/structs/terraform-asset-config.mdx | 2 +- .../python/structs/terraform-condition.mdx | 2 +- .../python/structs/terraform-constructor.mdx | 2 +- .../structs/terraform-element-metadata.mdx | 2 +- .../structs/terraform-hcl-module-config.mdx | 2 +- .../structs/terraform-meta-arguments.mdx | 2 +- .../structs/terraform-module-config.mdx | 2 +- .../structs/terraform-module-provider.mdx | 2 +- .../structs/terraform-module-user-config.mdx | 2 +- .../structs/terraform-output-config.mdx | 2 +- .../structs/terraform-provider-config.mdx | 2 +- .../terraform-provider-generator-metadata.mdx | 2 +- .../structs/terraform-resource-config.mdx | 2 +- .../structs/terraform-resource-import.mdx | 2 +- .../structs/terraform-resource-lifecycle.mdx | 2 +- .../structs/terraform-resource-move-by-id.mdx | 2 +- .../terraform-resource-move-by-target.mdx | 2 +- .../structs/terraform-stack-metadata.mdx | 2 +- .../structs/terraform-variable-config.mdx | 2 +- .../terraform-variable-validation-config.mdx | 2 +- .../python/structs/testing-app-config.mdx | 2 +- .../structs/winrm-provisioner-connection.mdx | 2 +- .../typescript/classes/annotations.mdx | 2 +- .../typescript/classes/any-list-list.mdx | 2 +- .../typescript/classes/any-list-map.mdx | 2 +- .../typescript/classes/any-map-list.mdx | 2 +- .../typescript/classes/any-map.mdx | 2 +- .../typescript/classes/aspects.mdx | 2 +- .../typescript/classes/assertion-return.mdx | 2 +- .../typescript/classes/boolean-list-list.mdx | 2 +- .../typescript/classes/boolean-list-map.mdx | 2 +- .../typescript/classes/boolean-list.mdx | 2 +- .../typescript/classes/boolean-map-list.mdx | 2 +- .../typescript/classes/boolean-map.mdx | 2 +- .../typescript/classes/cloud-workspace.mdx | 2 +- .../classes/complex-computed-list.mdx | 2 +- .../typescript/classes/complex-list.mdx | 2 +- .../typescript/classes/complex-map.mdx | 2 +- .../typescript/classes/complex-object.mdx | 2 +- .../classes/default-token-resolver.mdx | 2 +- .../dynamic-list-terraform-iterator.mdx | 2 +- .../typescript/classes/fn-generated.mdx | 139 +++++++++++++++- .../api-reference/typescript/classes/fn.mdx | 139 +++++++++++++++- .../typescript/classes/lazy-base.mdx | 2 +- .../api-reference/typescript/classes/lazy.mdx | 2 +- .../classes/list-terraform-iterator.mdx | 2 +- .../typescript/classes/manifest.mdx | 2 +- .../typescript/classes/map-list.mdx | 2 +- .../classes/map-terraform-iterator.mdx | 2 +- .../typescript/classes/migrate-ids.mdx | 2 +- .../classes/named-cloud-workspace.mdx | 2 +- .../classes/named-remote-workspace.mdx | 2 +- .../typescript/classes/number-list-list.mdx | 2 +- .../typescript/classes/number-list-map.mdx | 2 +- .../typescript/classes/number-map-list.mdx | 2 +- .../typescript/classes/number-map.mdx | 2 +- .../api-reference/typescript/classes/op.mdx | 2 +- .../classes/prefixed-remote-workspaces.mdx | 2 +- .../classes/resource-terraform-iterator.mdx | 2 +- .../typescript/classes/string-concat.mdx | 2 +- .../typescript/classes/string-list-list.mdx | 2 +- .../typescript/classes/string-list-map.mdx | 2 +- .../typescript/classes/string-map-list.mdx | 2 +- .../typescript/classes/string-map-map.mdx | 2 +- .../typescript/classes/string-map.mdx | 2 +- .../classes/tagged-cloud-workspaces.mdx | 2 +- .../typescript/classes/terraform-count.mdx | 2 +- .../typescript/classes/terraform-iterator.mdx | 2 +- .../classes/terraform-resource-targets.mdx | 2 +- .../typescript/classes/terraform-self.mdx | 2 +- .../typescript/classes/testing.mdx | 2 +- .../typescript/classes/token.mdx | 2 +- .../typescript/classes/tokenization.mdx | 2 +- .../classes/tokenized-string-fragments.mdx | 2 +- .../typescript/classes/variable-type.mdx | 2 +- .../typescript/constructs/app.mdx | 24 ++- .../typescript/constructs/azurerm-backend.mdx | 24 ++- .../typescript/constructs/cloud-backend.mdx | 24 ++- .../typescript/constructs/consul-backend.mdx | 24 ++- .../typescript/constructs/cos-backend.mdx | 24 ++- .../typescript/constructs/data-resource.mdx | 24 ++- .../data-terraform-remote-state-azurerm.mdx | 24 ++- .../data-terraform-remote-state-consul.mdx | 24 ++- .../data-terraform-remote-state-cos.mdx | 24 ++- .../data-terraform-remote-state-gcs.mdx | 24 ++- .../data-terraform-remote-state-http.mdx | 24 ++- .../data-terraform-remote-state-local.mdx | 24 ++- .../data-terraform-remote-state-oss.mdx | 24 ++- .../data-terraform-remote-state-pg.mdx | 24 ++- .../data-terraform-remote-state-s3.mdx | 24 ++- .../data-terraform-remote-state-swift.mdx | 24 ++- .../data-terraform-remote-state.mdx | 24 ++- .../typescript/constructs/gcs-backend.mdx | 24 ++- .../typescript/constructs/http-backend.mdx | 24 ++- .../constructs/importable-resource.mdx | 24 ++- .../typescript/constructs/local-backend.mdx | 24 ++- .../typescript/constructs/oss-backend.mdx | 24 ++- .../typescript/constructs/pg-backend.mdx | 24 ++- .../typescript/constructs/remote-backend.mdx | 24 ++- .../typescript/constructs/resource.mdx | 24 ++- .../typescript/constructs/s3-backend.mdx | 24 ++- .../typescript/constructs/swift-backend.mdx | 24 ++- .../typescript/constructs/terraform-asset.mdx | 24 ++- .../constructs/terraform-backend.mdx | 24 ++- .../constructs/terraform-data-source.mdx | 24 ++- .../constructs/terraform-element.mdx | 24 ++- .../constructs/terraform-hcl-module.mdx | 24 ++- .../typescript/constructs/terraform-local.mdx | 24 ++- .../constructs/terraform-module.mdx | 24 ++- .../constructs/terraform-output.mdx | 24 ++- .../constructs/terraform-provider.mdx | 24 ++- .../constructs/terraform-remote-state.mdx | 24 ++- .../constructs/terraform-resource.mdx | 24 ++- .../typescript/constructs/terraform-stack.mdx | 24 ++- .../constructs/terraform-variable.mdx | 24 ++- .../enums/annotation-metadata-entry-type.mdx | 2 +- .../typescript/enums/asset-type.mdx | 2 +- .../typescript/protocols/i-any-producer.mdx | 2 +- .../typescript/protocols/i-aspect.mdx | 2 +- .../protocols/i-fragment-concatenator.mdx | 2 +- .../protocols/i-importable-config.mdx | 2 +- .../protocols/i-interpolating-parent.mdx | 2 +- .../typescript/protocols/i-list-producer.mdx | 2 +- .../typescript/protocols/i-manifest.mdx | 2 +- .../protocols/i-number-producer.mdx | 2 +- .../typescript/protocols/i-post-processor.mdx | 2 +- .../protocols/i-remote-workspace.mdx | 2 +- .../typescript/protocols/i-resolvable.mdx | 2 +- .../protocols/i-resolve-context.mdx | 2 +- .../protocols/i-resource-constructor.mdx | 2 +- .../typescript/protocols/i-resource.mdx | 2 +- .../typescript/protocols/i-scope-callback.mdx | 2 +- .../protocols/i-stack-synthesizer.mdx | 2 +- .../protocols/i-string-producer.mdx | 2 +- .../protocols/i-synthesis-session.mdx | 2 +- .../protocols/i-terraform-addressable.mdx | 2 +- .../protocols/i-terraform-dependable.mdx | 2 +- .../protocols/i-terraform-iterator.mdx | 2 +- .../protocols/i-terraform-resource.mdx | 2 +- .../typescript/protocols/i-token-mapper.mdx | 2 +- .../typescript/protocols/i-token-resolver.mdx | 2 +- .../typescript/structs/app-config.mdx | 2 +- .../structs/azurerm-backend-config.mdx | 2 +- .../structs/cloud-backend-config.mdx | 2 +- .../structs/consul-backend-config.mdx | 2 +- .../structs/cos-backend-assume-role.mdx | 2 +- .../typescript/structs/cos-backend-config.mdx | 2 +- .../typescript/structs/data-config.mdx | 2 +- ...-terraform-remote-state-azurerm-config.mdx | 2 +- .../data-terraform-remote-state-config.mdx | 2 +- ...a-terraform-remote-state-consul-config.mdx | 2 +- ...data-terraform-remote-state-cos-config.mdx | 2 +- ...data-terraform-remote-state-gcs-config.mdx | 2 +- ...ata-terraform-remote-state-http-config.mdx | 2 +- ...ta-terraform-remote-state-local-config.mdx | 2 +- ...data-terraform-remote-state-oss-config.mdx | 2 +- .../data-terraform-remote-state-pg-config.mdx | 2 +- ...a-terraform-remote-state-remote-config.mdx | 2 +- .../data-terraform-remote-state-s3-config.mdx | 26 ++- ...ta-terraform-remote-state-swift-config.mdx | 2 +- .../typescript/structs/encoding-options.mdx | 2 +- .../typescript/structs/file-provisioner.mdx | 2 +- .../typescript/structs/gcs-backend-config.mdx | 2 +- .../structs/http-backend-config.mdx | 2 +- .../structs/lazy-any-value-options.mdx | 2 +- .../structs/lazy-list-value-options.mdx | 2 +- .../structs/lazy-string-value-options.mdx | 2 +- .../structs/local-backend-config.mdx | 2 +- .../structs/local-exec-provisioner.mdx | 2 +- .../typescript/structs/oss-assume-role.mdx | 2 +- .../typescript/structs/oss-backend-config.mdx | 2 +- .../typescript/structs/pg-backend-config.mdx | 2 +- .../typescript/structs/postcondition.mdx | 2 +- .../typescript/structs/precondition.mdx | 2 +- .../structs/remote-backend-config.mdx | 2 +- .../structs/remote-exec-provisioner.mdx | 2 +- .../typescript/structs/resolve-options.mdx | 2 +- .../structs/s3-backend-assume-role-config.mdx | 2 +- ...d-assume-role-with-web-identity-config.mdx | 2 +- .../typescript/structs/s3-backend-config.mdx | 26 ++- .../structs/s3-backend-endpoint-config.mdx | 2 +- .../structs/ssh-provisioner-connection.mdx | 2 +- .../typescript/structs/stack-annotation.mdx | 2 +- .../typescript/structs/stack-manifest.mdx | 2 +- .../structs/swift-backend-config.mdx | 2 +- .../structs/terraform-asset-config.mdx | 2 +- .../structs/terraform-condition.mdx | 2 +- .../structs/terraform-constructor.mdx | 2 +- .../structs/terraform-element-metadata.mdx | 2 +- .../structs/terraform-hcl-module-config.mdx | 2 +- .../structs/terraform-meta-arguments.mdx | 2 +- .../structs/terraform-module-config.mdx | 2 +- .../structs/terraform-module-provider.mdx | 2 +- .../structs/terraform-module-user-config.mdx | 2 +- .../structs/terraform-output-config.mdx | 2 +- .../structs/terraform-provider-config.mdx | 2 +- .../terraform-provider-generator-metadata.mdx | 2 +- .../structs/terraform-resource-config.mdx | 2 +- .../structs/terraform-resource-import.mdx | 2 +- .../structs/terraform-resource-lifecycle.mdx | 2 +- .../structs/terraform-resource-move-by-id.mdx | 2 +- .../terraform-resource-move-by-target.mdx | 2 +- .../structs/terraform-stack-metadata.mdx | 2 +- .../structs/terraform-variable-config.mdx | 2 +- .../terraform-variable-validation-config.mdx | 2 +- .../typescript/structs/testing-app-config.mdx | 2 +- .../structs/winrm-provisioner-connection.mdx | 2 +- 925 files changed, 7131 insertions(+), 943 deletions(-) diff --git a/content/api-reference/csharp/classes/annotations.mdx b/content/api-reference/csharp/classes/annotations.mdx index 391f9a3..60d3572 100644 --- a/content/api-reference/csharp/classes/annotations.mdx +++ b/content/api-reference/csharp/classes/annotations.mdx @@ -4,7 +4,7 @@ sidebarTitle: Annotations description: CDKTN Core API Reference for Annotations in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Includes API for attaching annotations such as warning messages to constructs. diff --git a/content/api-reference/csharp/classes/any-list-list.mdx b/content/api-reference/csharp/classes/any-list-list.mdx index ad38ea1..795e778 100644 --- a/content/api-reference/csharp/classes/any-list-list.mdx +++ b/content/api-reference/csharp/classes/any-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyListList description: CDKTN Core API Reference for AnyListList in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/any-list-map.mdx b/content/api-reference/csharp/classes/any-list-map.mdx index a2a41e9..04b1cdb 100644 --- a/content/api-reference/csharp/classes/any-list-map.mdx +++ b/content/api-reference/csharp/classes/any-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyListMap description: CDKTN Core API Reference for AnyListMap in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/any-map-list.mdx b/content/api-reference/csharp/classes/any-map-list.mdx index ba74c22..e8820f1 100644 --- a/content/api-reference/csharp/classes/any-map-list.mdx +++ b/content/api-reference/csharp/classes/any-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyMapList description: CDKTN Core API Reference for AnyMapList in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/any-map.mdx b/content/api-reference/csharp/classes/any-map.mdx index c6daf04..b0aa02d 100644 --- a/content/api-reference/csharp/classes/any-map.mdx +++ b/content/api-reference/csharp/classes/any-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyMap description: CDKTN Core API Reference for AnyMap in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/csharp/classes/aspects.mdx b/content/api-reference/csharp/classes/aspects.mdx index 80511f4..7fbd609 100644 --- a/content/api-reference/csharp/classes/aspects.mdx +++ b/content/api-reference/csharp/classes/aspects.mdx @@ -4,7 +4,7 @@ sidebarTitle: Aspects description: CDKTN Core API Reference for Aspects in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis. diff --git a/content/api-reference/csharp/classes/assertion-return.mdx b/content/api-reference/csharp/classes/assertion-return.mdx index 7e023db..f3f6a98 100644 --- a/content/api-reference/csharp/classes/assertion-return.mdx +++ b/content/api-reference/csharp/classes/assertion-return.mdx @@ -4,7 +4,7 @@ sidebarTitle: AssertionReturn description: CDKTN Core API Reference for AssertionReturn in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Class representing the contents of a return by an assertion. diff --git a/content/api-reference/csharp/classes/boolean-list-list.mdx b/content/api-reference/csharp/classes/boolean-list-list.mdx index a281466..ad2a70b 100644 --- a/content/api-reference/csharp/classes/boolean-list-list.mdx +++ b/content/api-reference/csharp/classes/boolean-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanListList description: CDKTN Core API Reference for BooleanListList in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/boolean-list-map.mdx b/content/api-reference/csharp/classes/boolean-list-map.mdx index 489743d..94096aa 100644 --- a/content/api-reference/csharp/classes/boolean-list-map.mdx +++ b/content/api-reference/csharp/classes/boolean-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanListMap description: CDKTN Core API Reference for BooleanListMap in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/boolean-list.mdx b/content/api-reference/csharp/classes/boolean-list.mdx index 3872384..9109d5f 100644 --- a/content/api-reference/csharp/classes/boolean-list.mdx +++ b/content/api-reference/csharp/classes/boolean-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanList description: CDKTN Core API Reference for BooleanList in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/boolean-map-list.mdx b/content/api-reference/csharp/classes/boolean-map-list.mdx index 5c306a8..564c24f 100644 --- a/content/api-reference/csharp/classes/boolean-map-list.mdx +++ b/content/api-reference/csharp/classes/boolean-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanMapList description: CDKTN Core API Reference for BooleanMapList in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/boolean-map.mdx b/content/api-reference/csharp/classes/boolean-map.mdx index c5508af..e0fbf09 100644 --- a/content/api-reference/csharp/classes/boolean-map.mdx +++ b/content/api-reference/csharp/classes/boolean-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanMap description: CDKTN Core API Reference for BooleanMap in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/csharp/classes/cloud-workspace.mdx b/content/api-reference/csharp/classes/cloud-workspace.mdx index 0425813..53b7e37 100644 --- a/content/api-reference/csharp/classes/cloud-workspace.mdx +++ b/content/api-reference/csharp/classes/cloud-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudWorkspace description: CDKTN Core API Reference for CloudWorkspace in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} A cloud workspace can either be a single named workspace, or a list of tagged workspaces. diff --git a/content/api-reference/csharp/classes/complex-computed-list.mdx b/content/api-reference/csharp/classes/complex-computed-list.mdx index b100a49..39caf2b 100644 --- a/content/api-reference/csharp/classes/complex-computed-list.mdx +++ b/content/api-reference/csharp/classes/complex-computed-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexComputedList description: CDKTN Core API Reference for ComplexComputedList in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IInterpolatingParent, IResolvable, ITerraformAddressable diff --git a/content/api-reference/csharp/classes/complex-list.mdx b/content/api-reference/csharp/classes/complex-list.mdx index 2713fc2..f384464 100644 --- a/content/api-reference/csharp/classes/complex-list.mdx +++ b/content/api-reference/csharp/classes/complex-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexList description: CDKTN Core API Reference for ComplexList in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/csharp/classes/complex-map.mdx b/content/api-reference/csharp/classes/complex-map.mdx index f716dfa..2250049 100644 --- a/content/api-reference/csharp/classes/complex-map.mdx +++ b/content/api-reference/csharp/classes/complex-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexMap description: CDKTN Core API Reference for ComplexMap in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/csharp/classes/complex-object.mdx b/content/api-reference/csharp/classes/complex-object.mdx index dbcb62b..260ffaf 100644 --- a/content/api-reference/csharp/classes/complex-object.mdx +++ b/content/api-reference/csharp/classes/complex-object.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexObject description: CDKTN Core API Reference for ComplexObject in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IInterpolatingParent, IResolvable, ITerraformAddressable diff --git a/content/api-reference/csharp/classes/default-token-resolver.mdx b/content/api-reference/csharp/classes/default-token-resolver.mdx index 4c05ed3..b45a66a 100644 --- a/content/api-reference/csharp/classes/default-token-resolver.mdx +++ b/content/api-reference/csharp/classes/default-token-resolver.mdx @@ -4,7 +4,7 @@ sidebarTitle: DefaultTokenResolver description: CDKTN Core API Reference for DefaultTokenResolver in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITokenResolver diff --git a/content/api-reference/csharp/classes/dynamic-list-terraform-iterator.mdx b/content/api-reference/csharp/classes/dynamic-list-terraform-iterator.mdx index 65ec329..c934092 100644 --- a/content/api-reference/csharp/classes/dynamic-list-terraform-iterator.mdx +++ b/content/api-reference/csharp/classes/dynamic-list-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: DynamicListTerraformIterator description: CDKTN Core API Reference for DynamicListTerraformIterator in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/fn-generated.mdx b/content/api-reference/csharp/classes/fn-generated.mdx index c6c5d34..f5d6131 100644 --- a/content/api-reference/csharp/classes/fn-generated.mdx +++ b/content/api-reference/csharp/classes/fn-generated.mdx @@ -4,7 +4,7 @@ sidebarTitle: FnGenerated description: CDKTN Core API Reference for FnGenerated in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -29,6 +29,7 @@ new FnGenerated(); | Anytrue | [anytrue](https://developer.hashicorp.com/terraform/language/functions/anytrue) returns `true` if any element in a given collection is `true` or `"true"`. It also returns `false` if the collection is empty. | | Base64decode | [base64decode](https://developer.hashicorp.com/terraform/language/functions/base64decode) takes a string containing a Base64 character sequence and returns the original string. | | Base64encode | [base64encode](https://developer.hashicorp.com/terraform/language/functions/base64encode) applies Base64 encoding to a string. | +| Base64gunzip | [base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. | | Base64gzip | [base64gzip](https://developer.hashicorp.com/terraform/language/functions/base64gzip) compresses a string with gzip and then encodes the result in Base64 encoding. | | Base64sha256 | [base64sha256](https://developer.hashicorp.com/terraform/language/functions/base64sha256) computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()` returns hexadecimal representation. | | Base64sha512 | [base64sha512](https://developer.hashicorp.com/terraform/language/functions/base64sha512) computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha512("test"))` since `sha512()` returns hexadecimal representation. | @@ -37,6 +38,7 @@ new FnGenerated(); | Ceil | [ceil](https://developer.hashicorp.com/terraform/language/functions/ceil) returns the closest whole number that is greater than or equal to the given value, which may be a fraction. | | Chomp | [chomp](https://developer.hashicorp.com/terraform/language/functions/chomp) removes newline characters at the end of a string. | | Chunklist | [chunklist](https://developer.hashicorp.com/terraform/language/functions/chunklist) splits a single list into fixed-size chunks, returning a list of lists. | +| Cidrcontains | [cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. | | Cidrhost | [cidrhost](https://developer.hashicorp.com/terraform/language/functions/cidrhost) calculates a full host IP address for a given host number within a given IP network address prefix. | | Cidrnetmask | [cidrnetmask](https://developer.hashicorp.com/terraform/language/functions/cidrnetmask) converts an IPv4 address prefix given in CIDR notation into a subnet mask address. | | Cidrsubnet | [cidrsubnet](https://developer.hashicorp.com/terraform/language/functions/cidrsubnet) calculates a subnet address within given IP network address prefix. | @@ -46,11 +48,13 @@ new FnGenerated(); | Compact | [compact](https://developer.hashicorp.com/terraform/language/functions/compact) takes a list of strings and returns a new list with any empty string elements removed. | | Concat | [concat](https://developer.hashicorp.com/terraform/language/functions/concat) takes two or more lists and combines them into a single list. | | Contains | [contains](https://developer.hashicorp.com/terraform/language/functions/contains) determines whether a given list or set contains a given single value as one of its elements. | +| Convert | [convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. | | Csvdecode | [csvdecode](https://developer.hashicorp.com/terraform/language/functions/csvdecode) decodes a string containing CSV-formatted data and produces a list of maps representing that data. | | Dirname | [dirname](https://developer.hashicorp.com/terraform/language/functions/dirname) takes a string containing a filesystem path and removes the last portion from it. | | Distinct | [distinct](https://developer.hashicorp.com/terraform/language/functions/distinct) takes a list and returns a new list with any duplicate elements removed. | | Element | [element](https://developer.hashicorp.com/terraform/language/functions/element) retrieves a single element from a list. | | Endswith | [endswith](https://developer.hashicorp.com/terraform/language/functions/endswith) takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix. | +| Ephemeralasnull | [ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. | | File | [file](https://developer.hashicorp.com/terraform/language/functions/file) reads the contents of a file at the given path and returns them as a string. | | Filebase64 | [filebase64](https://developer.hashicorp.com/terraform/language/functions/filebase64) reads the contents of a file at the given path and returns them as a base64-encoded string. | | Filebase64sha256 | [filebase64sha256](https://developer.hashicorp.com/terraform/language/functions/filebase64sha256) is a variant of `base64sha256` that hashes the contents of a given file rather than a literal string. | @@ -68,6 +72,7 @@ new FnGenerated(); | Formatlist | [formatlist](https://developer.hashicorp.com/terraform/language/functions/formatlist) produces a list of strings by formatting a number of other values according to a specification string. | | Indent | [indent](https://developer.hashicorp.com/terraform/language/functions/indent) adds a given number of spaces to the beginnings of all but the first line in a given multi-line string. | | Index | [index](https://developer.hashicorp.com/terraform/language/functions/index) finds the element index for a given value in a list. | +| Issensitive | [issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. | | Jsondecode | [jsondecode](https://developer.hashicorp.com/terraform/language/functions/jsondecode) interprets a given string as JSON, returning a representation of the result of decoding that string. | | Jsonencode | [jsonencode](https://developer.hashicorp.com/terraform/language/functions/jsonencode) encodes a given value to a string using JSON syntax. | | Keys | [keys](https://developer.hashicorp.com/terraform/language/functions/keys) takes a map and returns a list containing the keys from that map. | @@ -108,6 +113,7 @@ new FnGenerated(); | Substr | [substr](https://developer.hashicorp.com/terraform/language/functions/substr) extracts a substring from a given string by offset and (maximum) length. | | Sum | [sum](https://developer.hashicorp.com/terraform/language/functions/sum) takes a list or set of numbers and returns the sum of those numbers. | | Templatefile | [templatefile](https://developer.hashicorp.com/terraform/language/functions/templatefile) reads the file at the given path and renders its content as a template using a supplied set of template variables. | +| Templatestring | [templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. | | Textdecodebase64 | [textdecodebase64](https://developer.hashicorp.com/terraform/language/functions/textdecodebase64) function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding. | | Textencodebase64 | [textencodebase64](https://developer.hashicorp.com/terraform/language/functions/textencodebase64) encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters. | | Timeadd | [timeadd](https://developer.hashicorp.com/terraform/language/functions/timeadd) adds a duration to a timestamp, returning a new timestamp. | @@ -127,6 +133,7 @@ new FnGenerated(); | Trimsuffix | [trimsuffix](https://developer.hashicorp.com/terraform/language/functions/trimsuffix) removes the specified suffix from the end of the given string. | | Try | [try](https://developer.hashicorp.com/terraform/language/functions/try) evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors. | | Upper | [upper](https://developer.hashicorp.com/terraform/language/functions/upper) converts all cased letters in the given string to uppercase. | +| Urldecode | [urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. | | Urlencode | [urlencode](https://developer.hashicorp.com/terraform/language/functions/urlencode) applies URL encoding to a given string. | | Uuid | [uuid](https://developer.hashicorp.com/terraform/language/functions/uuid) generates a unique identifier string. | | Uuidv5 | [uuidv5](https://developer.hashicorp.com/terraform/language/functions/uuidv5) generates a *name-based* UUID, as described in [RFC 4122 section 4.3](https://tools.ietf.org/html/rfc4122#section-4.3), also known as a "version 5" UUID. | @@ -233,6 +240,22 @@ FnGenerated.Base64encode(string Str); *** +### `Base64gunzip` + +```csharp +using Io.Cdktn; + +FnGenerated.Base64gunzip(string Str); +``` + +[base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. + +#### `Str`Required + +- *Type:* string + +*** + ### `Base64gzip` ```csharp @@ -367,6 +390,28 @@ FnGenerated.Chunklist(object[] List, double Size); *** +### `Cidrcontains` + +```csharp +using Io.Cdktn; + +FnGenerated.Cidrcontains(string ContainingPrefix, string ContainedIpOrPrefix); +``` + +[cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. + +#### `ContainingPrefix`Required + +- *Type:* string + +*** + +#### `ContainedIpOrPrefix`Required + +- *Type:* string + +*** + ### `Cidrhost` ```csharp @@ -541,6 +586,28 @@ FnGenerated.Contains(object List, object Value); *** +### `Convert` + +```csharp +using Io.Cdktn; + +FnGenerated.Convert(object Value, object Type); +``` + +[convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. + +#### `Value`Required + +- *Type:* object + +*** + +#### `Type`Required + +- *Type:* object + +*** + ### `Csvdecode` ```csharp @@ -633,6 +700,22 @@ FnGenerated.Endswith(string Str, string Suffix); *** +### `Ephemeralasnull` + +```csharp +using Io.Cdktn; + +FnGenerated.Ephemeralasnull(object Value); +``` + +[ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. + +#### `Value`Required + +- *Type:* object + +*** + ### `File` ```csharp @@ -941,6 +1024,22 @@ FnGenerated.Index(object List, object Value); *** +### `Issensitive` + +```csharp +using Io.Cdktn; + +FnGenerated.Issensitive(object Value); +``` + +[issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. + +#### `Value`Required + +- *Type:* object + +*** + ### `Jsondecode` ```csharp @@ -1701,6 +1800,28 @@ FnGenerated.Templatefile(string Path, object Vars); *** +### `Templatestring` + +```csharp +using Io.Cdktn; + +FnGenerated.Templatestring(string Template, object Vars); +``` + +[templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. + +#### `Template`Required + +- *Type:* string + +*** + +#### `Vars`Required + +- *Type:* object + +*** + ### `Textdecodebase64` ```csharp @@ -2041,6 +2162,22 @@ FnGenerated.Upper(string Str); *** +### `Urldecode` + +```csharp +using Io.Cdktn; + +FnGenerated.Urldecode(string Str); +``` + +[urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. + +#### `Str`Required + +- *Type:* string + +*** + ### `Urlencode` ```csharp diff --git a/content/api-reference/csharp/classes/fn.mdx b/content/api-reference/csharp/classes/fn.mdx index 525588b..2ee3a6f 100644 --- a/content/api-reference/csharp/classes/fn.mdx +++ b/content/api-reference/csharp/classes/fn.mdx @@ -4,7 +4,7 @@ sidebarTitle: Fn description: CDKTN Core API Reference for Fn in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -29,6 +29,7 @@ new Fn(); | Anytrue | [anytrue](https://developer.hashicorp.com/terraform/language/functions/anytrue) returns `true` if any element in a given collection is `true` or `"true"`. It also returns `false` if the collection is empty. | | Base64decode | [base64decode](https://developer.hashicorp.com/terraform/language/functions/base64decode) takes a string containing a Base64 character sequence and returns the original string. | | Base64encode | [base64encode](https://developer.hashicorp.com/terraform/language/functions/base64encode) applies Base64 encoding to a string. | +| Base64gunzip | [base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. | | Base64gzip | [base64gzip](https://developer.hashicorp.com/terraform/language/functions/base64gzip) compresses a string with gzip and then encodes the result in Base64 encoding. | | Base64sha256 | [base64sha256](https://developer.hashicorp.com/terraform/language/functions/base64sha256) computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()` returns hexadecimal representation. | | Base64sha512 | [base64sha512](https://developer.hashicorp.com/terraform/language/functions/base64sha512) computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha512("test"))` since `sha512()` returns hexadecimal representation. | @@ -37,6 +38,7 @@ new Fn(); | Ceil | [ceil](https://developer.hashicorp.com/terraform/language/functions/ceil) returns the closest whole number that is greater than or equal to the given value, which may be a fraction. | | Chomp | [chomp](https://developer.hashicorp.com/terraform/language/functions/chomp) removes newline characters at the end of a string. | | Chunklist | [chunklist](https://developer.hashicorp.com/terraform/language/functions/chunklist) splits a single list into fixed-size chunks, returning a list of lists. | +| Cidrcontains | [cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. | | Cidrhost | [cidrhost](https://developer.hashicorp.com/terraform/language/functions/cidrhost) calculates a full host IP address for a given host number within a given IP network address prefix. | | Cidrnetmask | [cidrnetmask](https://developer.hashicorp.com/terraform/language/functions/cidrnetmask) converts an IPv4 address prefix given in CIDR notation into a subnet mask address. | | Cidrsubnet | [cidrsubnet](https://developer.hashicorp.com/terraform/language/functions/cidrsubnet) calculates a subnet address within given IP network address prefix. | @@ -46,11 +48,13 @@ new Fn(); | Compact | [compact](https://developer.hashicorp.com/terraform/language/functions/compact) takes a list of strings and returns a new list with any empty string elements removed. | | Concat | [concat](https://developer.hashicorp.com/terraform/language/functions/concat) takes two or more lists and combines them into a single list. | | Contains | [contains](https://developer.hashicorp.com/terraform/language/functions/contains) determines whether a given list or set contains a given single value as one of its elements. | +| Convert | [convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. | | Csvdecode | [csvdecode](https://developer.hashicorp.com/terraform/language/functions/csvdecode) decodes a string containing CSV-formatted data and produces a list of maps representing that data. | | Dirname | [dirname](https://developer.hashicorp.com/terraform/language/functions/dirname) takes a string containing a filesystem path and removes the last portion from it. | | Distinct | [distinct](https://developer.hashicorp.com/terraform/language/functions/distinct) takes a list and returns a new list with any duplicate elements removed. | | Element | [element](https://developer.hashicorp.com/terraform/language/functions/element) retrieves a single element from a list. | | Endswith | [endswith](https://developer.hashicorp.com/terraform/language/functions/endswith) takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix. | +| Ephemeralasnull | [ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. | | File | [file](https://developer.hashicorp.com/terraform/language/functions/file) reads the contents of a file at the given path and returns them as a string. | | Filebase64 | [filebase64](https://developer.hashicorp.com/terraform/language/functions/filebase64) reads the contents of a file at the given path and returns them as a base64-encoded string. | | Filebase64sha256 | [filebase64sha256](https://developer.hashicorp.com/terraform/language/functions/filebase64sha256) is a variant of `base64sha256` that hashes the contents of a given file rather than a literal string. | @@ -68,6 +72,7 @@ new Fn(); | Formatlist | [formatlist](https://developer.hashicorp.com/terraform/language/functions/formatlist) produces a list of strings by formatting a number of other values according to a specification string. | | Indent | [indent](https://developer.hashicorp.com/terraform/language/functions/indent) adds a given number of spaces to the beginnings of all but the first line in a given multi-line string. | | Index | [index](https://developer.hashicorp.com/terraform/language/functions/index) finds the element index for a given value in a list. | +| Issensitive | [issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. | | Jsondecode | [jsondecode](https://developer.hashicorp.com/terraform/language/functions/jsondecode) interprets a given string as JSON, returning a representation of the result of decoding that string. | | Jsonencode | [jsonencode](https://developer.hashicorp.com/terraform/language/functions/jsonencode) encodes a given value to a string using JSON syntax. | | Keys | [keys](https://developer.hashicorp.com/terraform/language/functions/keys) takes a map and returns a list containing the keys from that map. | @@ -108,6 +113,7 @@ new Fn(); | Substr | [substr](https://developer.hashicorp.com/terraform/language/functions/substr) extracts a substring from a given string by offset and (maximum) length. | | Sum | [sum](https://developer.hashicorp.com/terraform/language/functions/sum) takes a list or set of numbers and returns the sum of those numbers. | | Templatefile | [templatefile](https://developer.hashicorp.com/terraform/language/functions/templatefile) reads the file at the given path and renders its content as a template using a supplied set of template variables. | +| Templatestring | [templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. | | Textdecodebase64 | [textdecodebase64](https://developer.hashicorp.com/terraform/language/functions/textdecodebase64) function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding. | | Textencodebase64 | [textencodebase64](https://developer.hashicorp.com/terraform/language/functions/textencodebase64) encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters. | | Timeadd | [timeadd](https://developer.hashicorp.com/terraform/language/functions/timeadd) adds a duration to a timestamp, returning a new timestamp. | @@ -127,6 +133,7 @@ new Fn(); | Trimsuffix | [trimsuffix](https://developer.hashicorp.com/terraform/language/functions/trimsuffix) removes the specified suffix from the end of the given string. | | Try | [try](https://developer.hashicorp.com/terraform/language/functions/try) evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors. | | Upper | [upper](https://developer.hashicorp.com/terraform/language/functions/upper) converts all cased letters in the given string to uppercase. | +| Urldecode | [urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. | | Urlencode | [urlencode](https://developer.hashicorp.com/terraform/language/functions/urlencode) applies URL encoding to a given string. | | Uuid | [uuid](https://developer.hashicorp.com/terraform/language/functions/uuid) generates a unique identifier string. | | Uuidv5 | [uuidv5](https://developer.hashicorp.com/terraform/language/functions/uuidv5) generates a *name-based* UUID, as described in [RFC 4122 section 4.3](https://tools.ietf.org/html/rfc4122#section-4.3), also known as a "version 5" UUID. | @@ -240,6 +247,22 @@ Fn.Base64encode(string Str); *** +### `Base64gunzip` + +```csharp +using Io.Cdktn; + +Fn.Base64gunzip(string Str); +``` + +[base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. + +#### `Str`Required + +- *Type:* string + +*** + ### `Base64gzip` ```csharp @@ -374,6 +397,28 @@ Fn.Chunklist(object[] List, double Size); *** +### `Cidrcontains` + +```csharp +using Io.Cdktn; + +Fn.Cidrcontains(string ContainingPrefix, string ContainedIpOrPrefix); +``` + +[cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. + +#### `ContainingPrefix`Required + +- *Type:* string + +*** + +#### `ContainedIpOrPrefix`Required + +- *Type:* string + +*** + ### `Cidrhost` ```csharp @@ -548,6 +593,28 @@ Fn.Contains(object List, object Value); *** +### `Convert` + +```csharp +using Io.Cdktn; + +Fn.Convert(object Value, object Type); +``` + +[convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. + +#### `Value`Required + +- *Type:* object + +*** + +#### `Type`Required + +- *Type:* object + +*** + ### `Csvdecode` ```csharp @@ -640,6 +707,22 @@ Fn.Endswith(string Str, string Suffix); *** +### `Ephemeralasnull` + +```csharp +using Io.Cdktn; + +Fn.Ephemeralasnull(object Value); +``` + +[ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. + +#### `Value`Required + +- *Type:* object + +*** + ### `File` ```csharp @@ -948,6 +1031,22 @@ Fn.Index(object List, object Value); *** +### `Issensitive` + +```csharp +using Io.Cdktn; + +Fn.Issensitive(object Value); +``` + +[issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. + +#### `Value`Required + +- *Type:* object + +*** + ### `Jsondecode` ```csharp @@ -1708,6 +1807,28 @@ Fn.Templatefile(string Path, object Vars); *** +### `Templatestring` + +```csharp +using Io.Cdktn; + +Fn.Templatestring(string Template, object Vars); +``` + +[templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. + +#### `Template`Required + +- *Type:* string + +*** + +#### `Vars`Required + +- *Type:* object + +*** + ### `Textdecodebase64` ```csharp @@ -2048,6 +2169,22 @@ Fn.Upper(string Str); *** +### `Urldecode` + +```csharp +using Io.Cdktn; + +Fn.Urldecode(string Str); +``` + +[urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. + +#### `Str`Required + +- *Type:* string + +*** + ### `Urlencode` ```csharp diff --git a/content/api-reference/csharp/classes/lazy-base.mdx b/content/api-reference/csharp/classes/lazy-base.mdx index cd37510..7d5fee7 100644 --- a/content/api-reference/csharp/classes/lazy-base.mdx +++ b/content/api-reference/csharp/classes/lazy-base.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyBase description: CDKTN Core API Reference for LazyBase in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IResolvable diff --git a/content/api-reference/csharp/classes/lazy.mdx b/content/api-reference/csharp/classes/lazy.mdx index 139a924..08be1dc 100644 --- a/content/api-reference/csharp/classes/lazy.mdx +++ b/content/api-reference/csharp/classes/lazy.mdx @@ -4,7 +4,7 @@ sidebarTitle: Lazy description: CDKTN Core API Reference for Lazy in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Lazily produce a value. diff --git a/content/api-reference/csharp/classes/list-terraform-iterator.mdx b/content/api-reference/csharp/classes/list-terraform-iterator.mdx index 551b462..9c9d93c 100644 --- a/content/api-reference/csharp/classes/list-terraform-iterator.mdx +++ b/content/api-reference/csharp/classes/list-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ListTerraformIterator description: CDKTN Core API Reference for ListTerraformIterator in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/manifest.mdx b/content/api-reference/csharp/classes/manifest.mdx index a343de6..c17fb59 100644 --- a/content/api-reference/csharp/classes/manifest.mdx +++ b/content/api-reference/csharp/classes/manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: Manifest description: CDKTN Core API Reference for Manifest in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IManifest diff --git a/content/api-reference/csharp/classes/map-list.mdx b/content/api-reference/csharp/classes/map-list.mdx index bd441d7..bb22f13 100644 --- a/content/api-reference/csharp/classes/map-list.mdx +++ b/content/api-reference/csharp/classes/map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: MapList description: CDKTN Core API Reference for MapList in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IInterpolatingParent, IResolvable diff --git a/content/api-reference/csharp/classes/map-terraform-iterator.mdx b/content/api-reference/csharp/classes/map-terraform-iterator.mdx index 8c31452..7803ef3 100644 --- a/content/api-reference/csharp/classes/map-terraform-iterator.mdx +++ b/content/api-reference/csharp/classes/map-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: MapTerraformIterator description: CDKTN Core API Reference for MapTerraformIterator in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/migrate-ids.mdx b/content/api-reference/csharp/classes/migrate-ids.mdx index eb0c155..8eaae60 100644 --- a/content/api-reference/csharp/classes/migrate-ids.mdx +++ b/content/api-reference/csharp/classes/migrate-ids.mdx @@ -4,7 +4,7 @@ sidebarTitle: MigrateIds description: CDKTN Core API Reference for MigrateIds in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IAspect diff --git a/content/api-reference/csharp/classes/named-cloud-workspace.mdx b/content/api-reference/csharp/classes/named-cloud-workspace.mdx index d6e1255..80bf3b5 100644 --- a/content/api-reference/csharp/classes/named-cloud-workspace.mdx +++ b/content/api-reference/csharp/classes/named-cloud-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: NamedCloudWorkspace description: CDKTN Core API Reference for NamedCloudWorkspace in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The name of a single Terraform Cloud workspace. diff --git a/content/api-reference/csharp/classes/named-remote-workspace.mdx b/content/api-reference/csharp/classes/named-remote-workspace.mdx index c5058bd..3dcafa1 100644 --- a/content/api-reference/csharp/classes/named-remote-workspace.mdx +++ b/content/api-reference/csharp/classes/named-remote-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: NamedRemoteWorkspace description: CDKTN Core API Reference for NamedRemoteWorkspace in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IRemoteWorkspace diff --git a/content/api-reference/csharp/classes/number-list-list.mdx b/content/api-reference/csharp/classes/number-list-list.mdx index 607652f..f6fc825 100644 --- a/content/api-reference/csharp/classes/number-list-list.mdx +++ b/content/api-reference/csharp/classes/number-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberListList description: CDKTN Core API Reference for NumberListList in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/number-list-map.mdx b/content/api-reference/csharp/classes/number-list-map.mdx index 839dab2..f1845a7 100644 --- a/content/api-reference/csharp/classes/number-list-map.mdx +++ b/content/api-reference/csharp/classes/number-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberListMap description: CDKTN Core API Reference for NumberListMap in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/number-map-list.mdx b/content/api-reference/csharp/classes/number-map-list.mdx index 377fa08..7d8d71e 100644 --- a/content/api-reference/csharp/classes/number-map-list.mdx +++ b/content/api-reference/csharp/classes/number-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberMapList description: CDKTN Core API Reference for NumberMapList in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/number-map.mdx b/content/api-reference/csharp/classes/number-map.mdx index d8533d3..ab66bbd 100644 --- a/content/api-reference/csharp/classes/number-map.mdx +++ b/content/api-reference/csharp/classes/number-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberMap description: CDKTN Core API Reference for NumberMap in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/csharp/classes/op.mdx b/content/api-reference/csharp/classes/op.mdx index 05150b9..2647aa6 100644 --- a/content/api-reference/csharp/classes/op.mdx +++ b/content/api-reference/csharp/classes/op.mdx @@ -4,7 +4,7 @@ sidebarTitle: Op description: CDKTN Core API Reference for Op in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} This class contains static functions for all arithmetical and logical operators in the Terraform configuration language. diff --git a/content/api-reference/csharp/classes/prefixed-remote-workspaces.mdx b/content/api-reference/csharp/classes/prefixed-remote-workspaces.mdx index 84f3aae..a96c498 100644 --- a/content/api-reference/csharp/classes/prefixed-remote-workspaces.mdx +++ b/content/api-reference/csharp/classes/prefixed-remote-workspaces.mdx @@ -4,7 +4,7 @@ sidebarTitle: PrefixedRemoteWorkspaces description: CDKTN Core API Reference for PrefixedRemoteWorkspaces in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IRemoteWorkspace diff --git a/content/api-reference/csharp/classes/resource-terraform-iterator.mdx b/content/api-reference/csharp/classes/resource-terraform-iterator.mdx index 407ebc8..eb22246 100644 --- a/content/api-reference/csharp/classes/resource-terraform-iterator.mdx +++ b/content/api-reference/csharp/classes/resource-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ResourceTerraformIterator description: CDKTN Core API Reference for ResourceTerraformIterator in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/string-concat.mdx b/content/api-reference/csharp/classes/string-concat.mdx index f77bdef..7df4224 100644 --- a/content/api-reference/csharp/classes/string-concat.mdx +++ b/content/api-reference/csharp/classes/string-concat.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringConcat description: CDKTN Core API Reference for StringConcat in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IFragmentConcatenator diff --git a/content/api-reference/csharp/classes/string-list-list.mdx b/content/api-reference/csharp/classes/string-list-list.mdx index ec09e75..6989563 100644 --- a/content/api-reference/csharp/classes/string-list-list.mdx +++ b/content/api-reference/csharp/classes/string-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringListList description: CDKTN Core API Reference for StringListList in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/string-list-map.mdx b/content/api-reference/csharp/classes/string-list-map.mdx index 2f5416d..67bd726 100644 --- a/content/api-reference/csharp/classes/string-list-map.mdx +++ b/content/api-reference/csharp/classes/string-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringListMap description: CDKTN Core API Reference for StringListMap in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/string-map-list.mdx b/content/api-reference/csharp/classes/string-map-list.mdx index 9082cff..c2d0550 100644 --- a/content/api-reference/csharp/classes/string-map-list.mdx +++ b/content/api-reference/csharp/classes/string-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMapList description: CDKTN Core API Reference for StringMapList in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/string-map-map.mdx b/content/api-reference/csharp/classes/string-map-map.mdx index eb4b56f..a406e77 100644 --- a/content/api-reference/csharp/classes/string-map-map.mdx +++ b/content/api-reference/csharp/classes/string-map-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMapMap description: CDKTN Core API Reference for StringMapMap in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/csharp/classes/string-map.mdx b/content/api-reference/csharp/classes/string-map.mdx index f0e6a01..2b80b82 100644 --- a/content/api-reference/csharp/classes/string-map.mdx +++ b/content/api-reference/csharp/classes/string-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMap description: CDKTN Core API Reference for StringMap in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/csharp/classes/tagged-cloud-workspaces.mdx b/content/api-reference/csharp/classes/tagged-cloud-workspaces.mdx index eeb2d62..a9dbb49 100644 --- a/content/api-reference/csharp/classes/tagged-cloud-workspaces.mdx +++ b/content/api-reference/csharp/classes/tagged-cloud-workspaces.mdx @@ -4,7 +4,7 @@ sidebarTitle: TaggedCloudWorkspaces description: CDKTN Core API Reference for TaggedCloudWorkspaces in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} A set of Terraform Cloud workspace tags. diff --git a/content/api-reference/csharp/classes/terraform-count.mdx b/content/api-reference/csharp/classes/terraform-count.mdx index 2a22412..dfb95e2 100644 --- a/content/api-reference/csharp/classes/terraform-count.mdx +++ b/content/api-reference/csharp/classes/terraform-count.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformCount description: CDKTN Core API Reference for TerraformCount in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Iterator for the Terraform count property. diff --git a/content/api-reference/csharp/classes/terraform-iterator.mdx b/content/api-reference/csharp/classes/terraform-iterator.mdx index 1b1a57f..3d5e6d8 100644 --- a/content/api-reference/csharp/classes/terraform-iterator.mdx +++ b/content/api-reference/csharp/classes/terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformIterator description: CDKTN Core API Reference for TerraformIterator in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformIterator diff --git a/content/api-reference/csharp/classes/terraform-resource-targets.mdx b/content/api-reference/csharp/classes/terraform-resource-targets.mdx index 4992cdd..7c32ef8 100644 --- a/content/api-reference/csharp/classes/terraform-resource-targets.mdx +++ b/content/api-reference/csharp/classes/terraform-resource-targets.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceTargets description: CDKTN Core API Reference for TerraformResourceTargets in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/classes/terraform-self.mdx b/content/api-reference/csharp/classes/terraform-self.mdx index bc72c8c..8da612c 100644 --- a/content/api-reference/csharp/classes/terraform-self.mdx +++ b/content/api-reference/csharp/classes/terraform-self.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformSelf description: CDKTN Core API Reference for TerraformSelf in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Expressions in connection blocks cannot refer to their parent resource by name. diff --git a/content/api-reference/csharp/classes/testing.mdx b/content/api-reference/csharp/classes/testing.mdx index d4983df..55b7722 100644 --- a/content/api-reference/csharp/classes/testing.mdx +++ b/content/api-reference/csharp/classes/testing.mdx @@ -4,7 +4,7 @@ sidebarTitle: Testing description: CDKTN Core API Reference for Testing in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Testing utilities for cdktf applications. diff --git a/content/api-reference/csharp/classes/token.mdx b/content/api-reference/csharp/classes/token.mdx index eebeee0..44ecbcb 100644 --- a/content/api-reference/csharp/classes/token.mdx +++ b/content/api-reference/csharp/classes/token.mdx @@ -4,7 +4,7 @@ sidebarTitle: Token description: CDKTN Core API Reference for Token in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Represents a special or lazily-evaluated value. diff --git a/content/api-reference/csharp/classes/tokenization.mdx b/content/api-reference/csharp/classes/tokenization.mdx index f9aec32..e1f6f55 100644 --- a/content/api-reference/csharp/classes/tokenization.mdx +++ b/content/api-reference/csharp/classes/tokenization.mdx @@ -4,7 +4,7 @@ sidebarTitle: Tokenization description: CDKTN Core API Reference for Tokenization in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Less oft-needed functions to manipulate Tokens. diff --git a/content/api-reference/csharp/classes/tokenized-string-fragments.mdx b/content/api-reference/csharp/classes/tokenized-string-fragments.mdx index ac38755..48cd393 100644 --- a/content/api-reference/csharp/classes/tokenized-string-fragments.mdx +++ b/content/api-reference/csharp/classes/tokenized-string-fragments.mdx @@ -4,7 +4,7 @@ sidebarTitle: TokenizedStringFragments description: CDKTN Core API Reference for TokenizedStringFragments in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Fragments of a concatenated string containing stringified Tokens. diff --git a/content/api-reference/csharp/classes/variable-type.mdx b/content/api-reference/csharp/classes/variable-type.mdx index b252f96..8fc44e6 100644 --- a/content/api-reference/csharp/classes/variable-type.mdx +++ b/content/api-reference/csharp/classes/variable-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: VariableType description: CDKTN Core API Reference for VariableType in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/csharp/constructs/app.mdx b/content/api-reference/csharp/constructs/app.mdx index 7cd9df9..ac93206 100644 --- a/content/api-reference/csharp/constructs/app.mdx +++ b/content/api-reference/csharp/constructs/app.mdx @@ -4,7 +4,7 @@ sidebarTitle: App description: CDKTN Core API Reference for App in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Represents a cdktn application. @@ -35,6 +35,7 @@ configuration. | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | CrossStackReference | Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources. | | Synth | Synthesizes all resources to the output directory. | @@ -48,6 +49,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `CrossStackReference` ```csharp diff --git a/content/api-reference/csharp/constructs/azurerm-backend.mdx b/content/api-reference/csharp/constructs/azurerm-backend.mdx index bd72bf7..a7a9e59 100644 --- a/content/api-reference/csharp/constructs/azurerm-backend.mdx +++ b/content/api-reference/csharp/constructs/azurerm-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: AzurermBackend description: CDKTN Core API Reference for AzurermBackend in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new AzurermBackend(Construct Scope, AzurermBackendConfig Props); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/cloud-backend.mdx b/content/api-reference/csharp/constructs/cloud-backend.mdx index f62a748..d6fc623 100644 --- a/content/api-reference/csharp/constructs/cloud-backend.mdx +++ b/content/api-reference/csharp/constructs/cloud-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudBackend description: CDKTN Core API Reference for CloudBackend in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The Cloud Backend synthesizes a [cloud block](https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block). The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings. @@ -40,6 +40,7 @@ new CloudBackend(Construct Scope, CloudBackendConfig Props); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -58,6 +59,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/consul-backend.mdx b/content/api-reference/csharp/constructs/consul-backend.mdx index 64aed00..c1f7221 100644 --- a/content/api-reference/csharp/constructs/consul-backend.mdx +++ b/content/api-reference/csharp/constructs/consul-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: ConsulBackend description: CDKTN Core API Reference for ConsulBackend in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new ConsulBackend(Construct Scope, ConsulBackendConfig Props); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/cos-backend.mdx b/content/api-reference/csharp/constructs/cos-backend.mdx index d0ba4bf..8b795a8 100644 --- a/content/api-reference/csharp/constructs/cos-backend.mdx +++ b/content/api-reference/csharp/constructs/cos-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackend description: CDKTN Core API Reference for CosBackend in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new CosBackend(Construct Scope, CosBackendConfig Props); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/data-resource.mdx b/content/api-reference/csharp/constructs/data-resource.mdx index 962125b..349fbd0 100644 --- a/content/api-reference/csharp/constructs/data-resource.mdx +++ b/content/api-reference/csharp/constructs/data-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataResource description: CDKTN Core API Reference for DataResource in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The DataResource implements the standard resource lifecycle, but does not directly take any other actions. @@ -63,6 +63,7 @@ Must be unique amongst siblings in the same scope | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -98,6 +99,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/data-terraform-remote-state-azurerm.mdx b/content/api-reference/csharp/constructs/data-terraform-remote-state-azurerm.mdx index 0584150..6f4e89b 100644 --- a/content/api-reference/csharp/constructs/data-terraform-remote-state-azurerm.mdx +++ b/content/api-reference/csharp/constructs/data-terraform-remote-state-azurerm.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateAzurerm description: CDKTN Core API Reference for DataTerraformRemoteStateAzurerm in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateAzurerm(Construct Scope, string Id, DataTerraformRem | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/data-terraform-remote-state-consul.mdx b/content/api-reference/csharp/constructs/data-terraform-remote-state-consul.mdx index fd27a33..e52542d 100644 --- a/content/api-reference/csharp/constructs/data-terraform-remote-state-consul.mdx +++ b/content/api-reference/csharp/constructs/data-terraform-remote-state-consul.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConsul description: CDKTN Core API Reference for DataTerraformRemoteStateConsul in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateConsul(Construct Scope, string Id, DataTerraformRemo | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/data-terraform-remote-state-cos.mdx b/content/api-reference/csharp/constructs/data-terraform-remote-state-cos.mdx index ce3f433..1175731 100644 --- a/content/api-reference/csharp/constructs/data-terraform-remote-state-cos.mdx +++ b/content/api-reference/csharp/constructs/data-terraform-remote-state-cos.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateCos description: CDKTN Core API Reference for DataTerraformRemoteStateCos in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateCos(Construct Scope, string Id, DataTerraformRemoteS | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/data-terraform-remote-state-gcs.mdx b/content/api-reference/csharp/constructs/data-terraform-remote-state-gcs.mdx index df49fff..5eaf4da 100644 --- a/content/api-reference/csharp/constructs/data-terraform-remote-state-gcs.mdx +++ b/content/api-reference/csharp/constructs/data-terraform-remote-state-gcs.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateGcs description: CDKTN Core API Reference for DataTerraformRemoteStateGcs in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateGcs(Construct Scope, string Id, DataTerraformRemoteS | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/data-terraform-remote-state-http.mdx b/content/api-reference/csharp/constructs/data-terraform-remote-state-http.mdx index 01c8fb8..f229608 100644 --- a/content/api-reference/csharp/constructs/data-terraform-remote-state-http.mdx +++ b/content/api-reference/csharp/constructs/data-terraform-remote-state-http.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateHttp description: CDKTN Core API Reference for DataTerraformRemoteStateHttp in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateHttp(Construct Scope, string Id, DataTerraformRemote | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/data-terraform-remote-state-local.mdx b/content/api-reference/csharp/constructs/data-terraform-remote-state-local.mdx index 0b20666..97ff0d1 100644 --- a/content/api-reference/csharp/constructs/data-terraform-remote-state-local.mdx +++ b/content/api-reference/csharp/constructs/data-terraform-remote-state-local.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateLocal description: CDKTN Core API Reference for DataTerraformRemoteStateLocal in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateLocal(Construct Scope, string Id, DataTerraformRemot | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/data-terraform-remote-state-oss.mdx b/content/api-reference/csharp/constructs/data-terraform-remote-state-oss.mdx index afc9047..3090119 100644 --- a/content/api-reference/csharp/constructs/data-terraform-remote-state-oss.mdx +++ b/content/api-reference/csharp/constructs/data-terraform-remote-state-oss.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateOss description: CDKTN Core API Reference for DataTerraformRemoteStateOss in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateOss(Construct Scope, string Id, DataTerraformRemoteS | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/data-terraform-remote-state-pg.mdx b/content/api-reference/csharp/constructs/data-terraform-remote-state-pg.mdx index a5d63a7..3ec4a79 100644 --- a/content/api-reference/csharp/constructs/data-terraform-remote-state-pg.mdx +++ b/content/api-reference/csharp/constructs/data-terraform-remote-state-pg.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStatePg description: CDKTN Core API Reference for DataTerraformRemoteStatePg in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStatePg(Construct Scope, string Id, DataTerraformRemoteSt | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/data-terraform-remote-state-s3.mdx b/content/api-reference/csharp/constructs/data-terraform-remote-state-s3.mdx index 11ab27d..c92c391 100644 --- a/content/api-reference/csharp/constructs/data-terraform-remote-state-s3.mdx +++ b/content/api-reference/csharp/constructs/data-terraform-remote-state-s3.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateS3 description: CDKTN Core API Reference for DataTerraformRemoteStateS3 in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateS3(Construct Scope, string Id, DataTerraformRemoteSt | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/data-terraform-remote-state-swift.mdx b/content/api-reference/csharp/constructs/data-terraform-remote-state-swift.mdx index f653dd4..9b3438b 100644 --- a/content/api-reference/csharp/constructs/data-terraform-remote-state-swift.mdx +++ b/content/api-reference/csharp/constructs/data-terraform-remote-state-swift.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateSwift description: CDKTN Core API Reference for DataTerraformRemoteStateSwift in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateSwift(Construct Scope, string Id, DataTerraformRemot | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ private string ToString() Returns a string representation of this construct. +### ~~`With`~~ + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### ~~`AddOverride`~~ ```csharp diff --git a/content/api-reference/csharp/constructs/data-terraform-remote-state.mdx b/content/api-reference/csharp/constructs/data-terraform-remote-state.mdx index 7db4fdf..34503e7 100644 --- a/content/api-reference/csharp/constructs/data-terraform-remote-state.mdx +++ b/content/api-reference/csharp/constructs/data-terraform-remote-state.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteState description: CDKTN Core API Reference for DataTerraformRemoteState in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteState(Construct Scope, string Id, DataTerraformRemoteStat | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/gcs-backend.mdx b/content/api-reference/csharp/constructs/gcs-backend.mdx index 93c3a57..c149cfd 100644 --- a/content/api-reference/csharp/constructs/gcs-backend.mdx +++ b/content/api-reference/csharp/constructs/gcs-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: GcsBackend description: CDKTN Core API Reference for GcsBackend in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new GcsBackend(Construct Scope, GcsBackendConfig Props); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/http-backend.mdx b/content/api-reference/csharp/constructs/http-backend.mdx index 5406037..5cdeebd 100644 --- a/content/api-reference/csharp/constructs/http-backend.mdx +++ b/content/api-reference/csharp/constructs/http-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: HttpBackend description: CDKTN Core API Reference for HttpBackend in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new HttpBackend(Construct Scope, HttpBackendConfig Props); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/importable-resource.mdx b/content/api-reference/csharp/constructs/importable-resource.mdx index 1fe586f..503378e 100644 --- a/content/api-reference/csharp/constructs/importable-resource.mdx +++ b/content/api-reference/csharp/constructs/importable-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: ImportableResource description: CDKTN Core API Reference for ImportableResource in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Class used to represent an importable resource. @@ -47,6 +47,7 @@ new ImportableResource(Construct Scope, string Name, IImportableConfig Config); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -64,6 +65,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/local-backend.mdx b/content/api-reference/csharp/constructs/local-backend.mdx index 826b8a6..1cad03e 100644 --- a/content/api-reference/csharp/constructs/local-backend.mdx +++ b/content/api-reference/csharp/constructs/local-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalBackend description: CDKTN Core API Reference for LocalBackend in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new LocalBackend(Construct Scope, LocalBackendConfig Props = null); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/oss-backend.mdx b/content/api-reference/csharp/constructs/oss-backend.mdx index c35c6da..6776650 100644 --- a/content/api-reference/csharp/constructs/oss-backend.mdx +++ b/content/api-reference/csharp/constructs/oss-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssBackend description: CDKTN Core API Reference for OssBackend in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new OssBackend(Construct Scope, OssBackendConfig Props); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/pg-backend.mdx b/content/api-reference/csharp/constructs/pg-backend.mdx index 2297c40..71f8a8e 100644 --- a/content/api-reference/csharp/constructs/pg-backend.mdx +++ b/content/api-reference/csharp/constructs/pg-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: PgBackend description: CDKTN Core API Reference for PgBackend in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new PgBackend(Construct Scope, PgBackendConfig Props); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/remote-backend.mdx b/content/api-reference/csharp/constructs/remote-backend.mdx index 53195f2..d611938 100644 --- a/content/api-reference/csharp/constructs/remote-backend.mdx +++ b/content/api-reference/csharp/constructs/remote-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteBackend description: CDKTN Core API Reference for RemoteBackend in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new RemoteBackend(Construct Scope, RemoteBackendConfig Props); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/resource.mdx b/content/api-reference/csharp/constructs/resource.mdx index 713a783..3832609 100644 --- a/content/api-reference/csharp/constructs/resource.mdx +++ b/content/api-reference/csharp/constructs/resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: Resource description: CDKTN Core API Reference for Resource in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IResource @@ -42,6 +42,7 @@ new Resource(Construct Scope, string Id); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | *** @@ -53,6 +54,27 @@ private string ToString() Returns a string representation of this construct. +### ~~`With`~~ + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ## Static Functions | **Name** | **Description** | diff --git a/content/api-reference/csharp/constructs/s3-backend.mdx b/content/api-reference/csharp/constructs/s3-backend.mdx index 349ca4f..1123946 100644 --- a/content/api-reference/csharp/constructs/s3-backend.mdx +++ b/content/api-reference/csharp/constructs/s3-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3Backend description: CDKTN Core API Reference for S3Backend in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new S3Backend(Construct Scope, S3BackendConfig Props); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/swift-backend.mdx b/content/api-reference/csharp/constructs/swift-backend.mdx index 81c0264..b2e6502 100644 --- a/content/api-reference/csharp/constructs/swift-backend.mdx +++ b/content/api-reference/csharp/constructs/swift-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: SwiftBackend description: CDKTN Core API Reference for SwiftBackend in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new SwiftBackend(Construct Scope, SwiftBackendConfig Props); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ private string ToString() Returns a string representation of this construct. +### ~~`With`~~ + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### ~~`AddOverride`~~ ```csharp diff --git a/content/api-reference/csharp/constructs/terraform-asset.mdx b/content/api-reference/csharp/constructs/terraform-asset.mdx index 1068569..dfaf207 100644 --- a/content/api-reference/csharp/constructs/terraform-asset.mdx +++ b/content/api-reference/csharp/constructs/terraform-asset.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformAsset description: CDKTN Core API Reference for TerraformAsset in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new TerraformAsset(Construct Scope, string Id, TerraformAssetConfig Config); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | *** @@ -56,6 +57,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ## Static Functions | **Name** | **Description** | diff --git a/content/api-reference/csharp/constructs/terraform-backend.mdx b/content/api-reference/csharp/constructs/terraform-backend.mdx index 065525b..8c17ec8 100644 --- a/content/api-reference/csharp/constructs/terraform-backend.mdx +++ b/content/api-reference/csharp/constructs/terraform-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformBackend description: CDKTN Core API Reference for TerraformBackend in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new TerraformBackend(Construct Scope, string Id, string Name); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -63,6 +64,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/terraform-data-source.mdx b/content/api-reference/csharp/constructs/terraform-data-source.mdx index 2c0da9b..ef9d47d 100644 --- a/content/api-reference/csharp/constructs/terraform-data-source.mdx +++ b/content/api-reference/csharp/constructs/terraform-data-source.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformDataSource description: CDKTN Core API Reference for TerraformDataSource in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformResource, ITerraformDependable, IInterpolatingParent @@ -47,6 +47,7 @@ new TerraformDataSource(Construct Scope, string Id, TerraformResourceConfig Conf | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -74,6 +75,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/terraform-element.mdx b/content/api-reference/csharp/constructs/terraform-element.mdx index 97bf387..f87144b 100644 --- a/content/api-reference/csharp/constructs/terraform-element.mdx +++ b/content/api-reference/csharp/constructs/terraform-element.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformElement description: CDKTN Core API Reference for TerraformElement in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new TerraformElement(Construct Scope, string Id, string ElementType = null); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -62,6 +63,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/terraform-hcl-module.mdx b/content/api-reference/csharp/constructs/terraform-hcl-module.mdx index b60c2d2..4f0114d 100644 --- a/content/api-reference/csharp/constructs/terraform-hcl-module.mdx +++ b/content/api-reference/csharp/constructs/terraform-hcl-module.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformHclModule description: CDKTN Core API Reference for TerraformHclModule in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new TerraformHclModule(Construct Scope, string Id, TerraformHclModuleConfig Opti | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -70,6 +71,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/terraform-local.mdx b/content/api-reference/csharp/constructs/terraform-local.mdx index 93256ac..8c35574 100644 --- a/content/api-reference/csharp/constructs/terraform-local.mdx +++ b/content/api-reference/csharp/constructs/terraform-local.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformLocal description: CDKTN Core API Reference for TerraformLocal in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -47,6 +47,7 @@ new TerraformLocal(Construct Scope, string Id, object Expression); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -64,6 +65,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/terraform-module.mdx b/content/api-reference/csharp/constructs/terraform-module.mdx index 0de0b27..ef03ea2 100644 --- a/content/api-reference/csharp/constructs/terraform-module.mdx +++ b/content/api-reference/csharp/constructs/terraform-module.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModule description: CDKTN Core API Reference for TerraformModule in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformDependable @@ -56,6 +56,7 @@ new TerraformModule(Construct Scope, string Id, TerraformModuleConfig Options); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -76,6 +77,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/terraform-output.mdx b/content/api-reference/csharp/constructs/terraform-output.mdx index a5a822e..463d3b1 100644 --- a/content/api-reference/csharp/constructs/terraform-output.mdx +++ b/content/api-reference/csharp/constructs/terraform-output.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformOutput description: CDKTN Core API Reference for TerraformOutput in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new TerraformOutput(Construct Scope, string Id, TerraformOutputConfig Config); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -62,6 +63,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/terraform-provider.mdx b/content/api-reference/csharp/constructs/terraform-provider.mdx index 7f2c229..cfa2184 100644 --- a/content/api-reference/csharp/constructs/terraform-provider.mdx +++ b/content/api-reference/csharp/constructs/terraform-provider.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProvider description: CDKTN Core API Reference for TerraformProvider in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new TerraformProvider(Construct Scope, string Id, TerraformProviderConfig Config | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -62,6 +63,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/terraform-remote-state.mdx b/content/api-reference/csharp/constructs/terraform-remote-state.mdx index 7b13479..1feb29d 100644 --- a/content/api-reference/csharp/constructs/terraform-remote-state.mdx +++ b/content/api-reference/csharp/constructs/terraform-remote-state.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformRemoteState description: CDKTN Core API Reference for TerraformRemoteState in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -54,6 +54,7 @@ new TerraformRemoteState(Construct Scope, string Id, string Backend, DataTerrafo | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -76,6 +77,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/terraform-resource.mdx b/content/api-reference/csharp/constructs/terraform-resource.mdx index 6bb2f74..3738f1f 100644 --- a/content/api-reference/csharp/constructs/terraform-resource.mdx +++ b/content/api-reference/csharp/constructs/terraform-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResource description: CDKTN Core API Reference for TerraformResource in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformResource, ITerraformDependable, IInterpolatingParent @@ -47,6 +47,7 @@ new TerraformResource(Construct Scope, string Id, TerraformResourceConfig Config | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -80,6 +81,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/constructs/terraform-stack.mdx b/content/api-reference/csharp/constructs/terraform-stack.mdx index 2e384a9..800b293 100644 --- a/content/api-reference/csharp/constructs/terraform-stack.mdx +++ b/content/api-reference/csharp/constructs/terraform-stack.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformStack description: CDKTN Core API Reference for TerraformStack in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new TerraformStack(Construct Scope, string Id); | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddDependency | *No description.* | | AddOverride | *No description.* | | AllProviders | *No description.* | @@ -62,6 +63,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddDependency` ```csharp diff --git a/content/api-reference/csharp/constructs/terraform-variable.mdx b/content/api-reference/csharp/constructs/terraform-variable.mdx index ad9b325..f6ae085 100644 --- a/content/api-reference/csharp/constructs/terraform-variable.mdx +++ b/content/api-reference/csharp/constructs/terraform-variable.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariable description: CDKTN Core API Reference for TerraformVariable in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -47,6 +47,7 @@ new TerraformVariable(Construct Scope, string Id, TerraformVariableConfig Config | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ private string ToString() Returns a string representation of this construct. +### `With` + +```csharp +private IConstruct With(params IMixin[] Mixins) +``` + +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. + +#### `Mixins`Required + +- *Type:* params Constructs.IMixin\[] + +The mixins to apply. + +*** + ### `AddOverride` ```csharp diff --git a/content/api-reference/csharp/enums/annotation-metadata-entry-type.mdx b/content/api-reference/csharp/enums/annotation-metadata-entry-type.mdx index 6b8c074..fd68e26 100644 --- a/content/api-reference/csharp/enums/annotation-metadata-entry-type.mdx +++ b/content/api-reference/csharp/enums/annotation-metadata-entry-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnnotationMetadataEntryType description: CDKTN Core API Reference for AnnotationMetadataEntryType in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Members diff --git a/content/api-reference/csharp/enums/asset-type.mdx b/content/api-reference/csharp/enums/asset-type.mdx index 40646cb..b54789f 100644 --- a/content/api-reference/csharp/enums/asset-type.mdx +++ b/content/api-reference/csharp/enums/asset-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: AssetType description: CDKTN Core API Reference for AssetType in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Members diff --git a/content/api-reference/csharp/protocols/i-any-producer.mdx b/content/api-reference/csharp/protocols/i-any-producer.mdx index f7730c9..0dd2817 100644 --- a/content/api-reference/csharp/protocols/i-any-producer.mdx +++ b/content/api-reference/csharp/protocols/i-any-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IAnyProducer description: CDKTN Core API Reference for IAnyProducer in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IAnyProducer diff --git a/content/api-reference/csharp/protocols/i-aspect.mdx b/content/api-reference/csharp/protocols/i-aspect.mdx index afb1473..83fa113 100644 --- a/content/api-reference/csharp/protocols/i-aspect.mdx +++ b/content/api-reference/csharp/protocols/i-aspect.mdx @@ -4,7 +4,7 @@ sidebarTitle: IAspect description: CDKTN Core API Reference for IAspect in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* MigrateIds, IAspect diff --git a/content/api-reference/csharp/protocols/i-fragment-concatenator.mdx b/content/api-reference/csharp/protocols/i-fragment-concatenator.mdx index 71858c2..50c97af 100644 --- a/content/api-reference/csharp/protocols/i-fragment-concatenator.mdx +++ b/content/api-reference/csharp/protocols/i-fragment-concatenator.mdx @@ -4,7 +4,7 @@ sidebarTitle: IFragmentConcatenator description: CDKTN Core API Reference for IFragmentConcatenator in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* StringConcat, IFragmentConcatenator diff --git a/content/api-reference/csharp/protocols/i-importable-config.mdx b/content/api-reference/csharp/protocols/i-importable-config.mdx index 437e10d..0fceb1f 100644 --- a/content/api-reference/csharp/protocols/i-importable-config.mdx +++ b/content/api-reference/csharp/protocols/i-importable-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: IImportableConfig description: CDKTN Core API Reference for IImportableConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IImportableConfig diff --git a/content/api-reference/csharp/protocols/i-interpolating-parent.mdx b/content/api-reference/csharp/protocols/i-interpolating-parent.mdx index 7a1dbd5..942cf1c 100644 --- a/content/api-reference/csharp/protocols/i-interpolating-parent.mdx +++ b/content/api-reference/csharp/protocols/i-interpolating-parent.mdx @@ -4,7 +4,7 @@ sidebarTitle: IInterpolatingParent description: CDKTN Core API Reference for IInterpolatingParent in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyMapList, BooleanMapList, ComplexComputedList, ComplexObject, DataResource, MapList, NumberMapList, StringMapList, TerraformDataSource, TerraformResource, IInterpolatingParent diff --git a/content/api-reference/csharp/protocols/i-list-producer.mdx b/content/api-reference/csharp/protocols/i-list-producer.mdx index 5e7e34c..fd1ed85 100644 --- a/content/api-reference/csharp/protocols/i-list-producer.mdx +++ b/content/api-reference/csharp/protocols/i-list-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IListProducer description: CDKTN Core API Reference for IListProducer in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IListProducer diff --git a/content/api-reference/csharp/protocols/i-manifest.mdx b/content/api-reference/csharp/protocols/i-manifest.mdx index 82936fb..717fd62 100644 --- a/content/api-reference/csharp/protocols/i-manifest.mdx +++ b/content/api-reference/csharp/protocols/i-manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: IManifest description: CDKTN Core API Reference for IManifest in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* Manifest, IManifest diff --git a/content/api-reference/csharp/protocols/i-number-producer.mdx b/content/api-reference/csharp/protocols/i-number-producer.mdx index 56eb855..019ba9a 100644 --- a/content/api-reference/csharp/protocols/i-number-producer.mdx +++ b/content/api-reference/csharp/protocols/i-number-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: INumberProducer description: CDKTN Core API Reference for INumberProducer in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* INumberProducer diff --git a/content/api-reference/csharp/protocols/i-post-processor.mdx b/content/api-reference/csharp/protocols/i-post-processor.mdx index a0da2a2..78d2b0d 100644 --- a/content/api-reference/csharp/protocols/i-post-processor.mdx +++ b/content/api-reference/csharp/protocols/i-post-processor.mdx @@ -4,7 +4,7 @@ sidebarTitle: IPostProcessor description: CDKTN Core API Reference for IPostProcessor in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IPostProcessor diff --git a/content/api-reference/csharp/protocols/i-remote-workspace.mdx b/content/api-reference/csharp/protocols/i-remote-workspace.mdx index eeb220b..632d25f 100644 --- a/content/api-reference/csharp/protocols/i-remote-workspace.mdx +++ b/content/api-reference/csharp/protocols/i-remote-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: IRemoteWorkspace description: CDKTN Core API Reference for IRemoteWorkspace in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* NamedRemoteWorkspace, PrefixedRemoteWorkspaces, IRemoteWorkspace diff --git a/content/api-reference/csharp/protocols/i-resolvable.mdx b/content/api-reference/csharp/protocols/i-resolvable.mdx index 1b5703a..b2eda99 100644 --- a/content/api-reference/csharp/protocols/i-resolvable.mdx +++ b/content/api-reference/csharp/protocols/i-resolvable.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResolvable description: CDKTN Core API Reference for IResolvable in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyListList, AnyListMap, AnyMap, AnyMapList, BooleanList, BooleanListList, BooleanListMap, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, LazyBase, MapList, NumberListList, NumberListMap, NumberMap, NumberMapList, StringListList, StringListMap, StringMap, StringMapList, StringMapMap, IResolvable diff --git a/content/api-reference/csharp/protocols/i-resolve-context.mdx b/content/api-reference/csharp/protocols/i-resolve-context.mdx index 84c80c9..b321b5d 100644 --- a/content/api-reference/csharp/protocols/i-resolve-context.mdx +++ b/content/api-reference/csharp/protocols/i-resolve-context.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResolveContext description: CDKTN Core API Reference for IResolveContext in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IResolveContext diff --git a/content/api-reference/csharp/protocols/i-resource-constructor.mdx b/content/api-reference/csharp/protocols/i-resource-constructor.mdx index 4e726d7..dfc0c7f 100644 --- a/content/api-reference/csharp/protocols/i-resource-constructor.mdx +++ b/content/api-reference/csharp/protocols/i-resource-constructor.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResourceConstructor description: CDKTN Core API Reference for IResourceConstructor in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IResourceConstructor diff --git a/content/api-reference/csharp/protocols/i-resource.mdx b/content/api-reference/csharp/protocols/i-resource.mdx index d0c35e5..59b4c3c 100644 --- a/content/api-reference/csharp/protocols/i-resource.mdx +++ b/content/api-reference/csharp/protocols/i-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResource description: CDKTN Core API Reference for IResource in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Extends:* Constructs.IConstruct diff --git a/content/api-reference/csharp/protocols/i-scope-callback.mdx b/content/api-reference/csharp/protocols/i-scope-callback.mdx index 7d65727..21f7d7d 100644 --- a/content/api-reference/csharp/protocols/i-scope-callback.mdx +++ b/content/api-reference/csharp/protocols/i-scope-callback.mdx @@ -4,7 +4,7 @@ sidebarTitle: IScopeCallback description: CDKTN Core API Reference for IScopeCallback in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IScopeCallback diff --git a/content/api-reference/csharp/protocols/i-stack-synthesizer.mdx b/content/api-reference/csharp/protocols/i-stack-synthesizer.mdx index 57f709d..55d73d6 100644 --- a/content/api-reference/csharp/protocols/i-stack-synthesizer.mdx +++ b/content/api-reference/csharp/protocols/i-stack-synthesizer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IStackSynthesizer description: CDKTN Core API Reference for IStackSynthesizer in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IStackSynthesizer diff --git a/content/api-reference/csharp/protocols/i-string-producer.mdx b/content/api-reference/csharp/protocols/i-string-producer.mdx index b59e607..9c9d856 100644 --- a/content/api-reference/csharp/protocols/i-string-producer.mdx +++ b/content/api-reference/csharp/protocols/i-string-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IStringProducer description: CDKTN Core API Reference for IStringProducer in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IStringProducer diff --git a/content/api-reference/csharp/protocols/i-synthesis-session.mdx b/content/api-reference/csharp/protocols/i-synthesis-session.mdx index 47c0954..3613023 100644 --- a/content/api-reference/csharp/protocols/i-synthesis-session.mdx +++ b/content/api-reference/csharp/protocols/i-synthesis-session.mdx @@ -4,7 +4,7 @@ sidebarTitle: ISynthesisSession description: CDKTN Core API Reference for ISynthesisSession in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* ISynthesisSession diff --git a/content/api-reference/csharp/protocols/i-terraform-addressable.mdx b/content/api-reference/csharp/protocols/i-terraform-addressable.mdx index 0281077..4b1a3f3 100644 --- a/content/api-reference/csharp/protocols/i-terraform-addressable.mdx +++ b/content/api-reference/csharp/protocols/i-terraform-addressable.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformAddressable description: CDKTN Core API Reference for ITerraformAddressable in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyListList, AnyListMap, AnyMap, AnyMapList, BooleanList, BooleanListList, BooleanListMap, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, DataResource, DataTerraformRemoteState, DataTerraformRemoteStateAzurerm, DataTerraformRemoteStateConsul, DataTerraformRemoteStateCos, DataTerraformRemoteStateGcs, DataTerraformRemoteStateHttp, DataTerraformRemoteStateLocal, DataTerraformRemoteStateOss, DataTerraformRemoteStatePg, DataTerraformRemoteStateS3, DataTerraformRemoteStateSwift, MapList, NumberListList, NumberListMap, NumberMap, NumberMapList, StringListList, StringListMap, StringMap, StringMapList, StringMapMap, TerraformDataSource, TerraformHclModule, TerraformLocal, TerraformModule, TerraformRemoteState, TerraformResource, TerraformVariable, ITerraformAddressable, ITerraformDependable diff --git a/content/api-reference/csharp/protocols/i-terraform-dependable.mdx b/content/api-reference/csharp/protocols/i-terraform-dependable.mdx index 0eda965..69e261f 100644 --- a/content/api-reference/csharp/protocols/i-terraform-dependable.mdx +++ b/content/api-reference/csharp/protocols/i-terraform-dependable.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformDependable description: CDKTN Core API Reference for ITerraformDependable in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Extends:* ITerraformAddressable diff --git a/content/api-reference/csharp/protocols/i-terraform-iterator.mdx b/content/api-reference/csharp/protocols/i-terraform-iterator.mdx index c8659e0..1c40c46 100644 --- a/content/api-reference/csharp/protocols/i-terraform-iterator.mdx +++ b/content/api-reference/csharp/protocols/i-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformIterator description: CDKTN Core API Reference for ITerraformIterator in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DynamicListTerraformIterator, ListTerraformIterator, MapTerraformIterator, ResourceTerraformIterator, TerraformIterator, ITerraformIterator diff --git a/content/api-reference/csharp/protocols/i-terraform-resource.mdx b/content/api-reference/csharp/protocols/i-terraform-resource.mdx index c59e315..fb0805e 100644 --- a/content/api-reference/csharp/protocols/i-terraform-resource.mdx +++ b/content/api-reference/csharp/protocols/i-terraform-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformResource description: CDKTN Core API Reference for ITerraformResource in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DataResource, TerraformDataSource, TerraformResource, ITerraformResource diff --git a/content/api-reference/csharp/protocols/i-token-mapper.mdx b/content/api-reference/csharp/protocols/i-token-mapper.mdx index 282f280..4337227 100644 --- a/content/api-reference/csharp/protocols/i-token-mapper.mdx +++ b/content/api-reference/csharp/protocols/i-token-mapper.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITokenMapper description: CDKTN Core API Reference for ITokenMapper in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* ITokenMapper diff --git a/content/api-reference/csharp/protocols/i-token-resolver.mdx b/content/api-reference/csharp/protocols/i-token-resolver.mdx index 3358160..3c6a7a8 100644 --- a/content/api-reference/csharp/protocols/i-token-resolver.mdx +++ b/content/api-reference/csharp/protocols/i-token-resolver.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITokenResolver description: CDKTN Core API Reference for ITokenResolver in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DefaultTokenResolver, ITokenResolver diff --git a/content/api-reference/csharp/structs/app-config.mdx b/content/api-reference/csharp/structs/app-config.mdx index 306c16b..d1ce2bd 100644 --- a/content/api-reference/csharp/structs/app-config.mdx +++ b/content/api-reference/csharp/structs/app-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: AppConfig description: CDKTN Core API Reference for AppConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/azurerm-backend-config.mdx b/content/api-reference/csharp/structs/azurerm-backend-config.mdx index 070e590..063732e 100644 --- a/content/api-reference/csharp/structs/azurerm-backend-config.mdx +++ b/content/api-reference/csharp/structs/azurerm-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: AzurermBackendConfig description: CDKTN Core API Reference for AzurermBackendConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as a Blob with the given Key within the Blob Container within the Blob Storage Account. diff --git a/content/api-reference/csharp/structs/cloud-backend-config.mdx b/content/api-reference/csharp/structs/cloud-backend-config.mdx index d4a440a..1525f37 100644 --- a/content/api-reference/csharp/structs/cloud-backend-config.mdx +++ b/content/api-reference/csharp/structs/cloud-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudBackendConfig description: CDKTN Core API Reference for CloudBackendConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The Cloud Backend synthesizes a [cloud block](https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block). The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings. diff --git a/content/api-reference/csharp/structs/consul-backend-config.mdx b/content/api-reference/csharp/structs/consul-backend-config.mdx index 06451a9..8cc3e8b 100644 --- a/content/api-reference/csharp/structs/consul-backend-config.mdx +++ b/content/api-reference/csharp/structs/consul-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: ConsulBackendConfig description: CDKTN Core API Reference for ConsulBackendConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state in the Consul KV store at a given path. This backend supports state locking. diff --git a/content/api-reference/csharp/structs/cos-backend-assume-role.mdx b/content/api-reference/csharp/structs/cos-backend-assume-role.mdx index 7e60d1c..034db29 100644 --- a/content/api-reference/csharp/structs/cos-backend-assume-role.mdx +++ b/content/api-reference/csharp/structs/cos-backend-assume-role.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackendAssumeRole description: CDKTN Core API Reference for CosBackendAssumeRole in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/cos-backend-config.mdx b/content/api-reference/csharp/structs/cos-backend-config.mdx index f8cbf0d..dadcf34 100644 --- a/content/api-reference/csharp/structs/cos-backend-config.mdx +++ b/content/api-reference/csharp/structs/cos-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackendConfig description: CDKTN Core API Reference for CosBackendConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as an object in a configurable prefix in a given bucket on Tencent Cloud Object Storage (COS). diff --git a/content/api-reference/csharp/structs/data-config.mdx b/content/api-reference/csharp/structs/data-config.mdx index 5b8e6ee..2297199 100644 --- a/content/api-reference/csharp/structs/data-config.mdx +++ b/content/api-reference/csharp/structs/data-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataConfig description: CDKTN Core API Reference for DataConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/data-terraform-remote-state-azurerm-config.mdx b/content/api-reference/csharp/structs/data-terraform-remote-state-azurerm-config.mdx index 2420da6..1fa9893 100644 --- a/content/api-reference/csharp/structs/data-terraform-remote-state-azurerm-config.mdx +++ b/content/api-reference/csharp/structs/data-terraform-remote-state-azurerm-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateAzurermConfig description: CDKTN Core API Reference for DataTerraformRemoteStateAzurermConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/data-terraform-remote-state-config.mdx b/content/api-reference/csharp/structs/data-terraform-remote-state-config.mdx index 6fc7cb4..d2322ab 100644 --- a/content/api-reference/csharp/structs/data-terraform-remote-state-config.mdx +++ b/content/api-reference/csharp/structs/data-terraform-remote-state-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConfig description: CDKTN Core API Reference for DataTerraformRemoteStateConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/data-terraform-remote-state-consul-config.mdx b/content/api-reference/csharp/structs/data-terraform-remote-state-consul-config.mdx index 60cb4e9..52eaf80 100644 --- a/content/api-reference/csharp/structs/data-terraform-remote-state-consul-config.mdx +++ b/content/api-reference/csharp/structs/data-terraform-remote-state-consul-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConsulConfig description: CDKTN Core API Reference for DataTerraformRemoteStateConsulConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/data-terraform-remote-state-cos-config.mdx b/content/api-reference/csharp/structs/data-terraform-remote-state-cos-config.mdx index 14f8e8c..3386039 100644 --- a/content/api-reference/csharp/structs/data-terraform-remote-state-cos-config.mdx +++ b/content/api-reference/csharp/structs/data-terraform-remote-state-cos-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateCosConfig description: CDKTN Core API Reference for DataTerraformRemoteStateCosConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/data-terraform-remote-state-gcs-config.mdx b/content/api-reference/csharp/structs/data-terraform-remote-state-gcs-config.mdx index 4542b46..74f92b7 100644 --- a/content/api-reference/csharp/structs/data-terraform-remote-state-gcs-config.mdx +++ b/content/api-reference/csharp/structs/data-terraform-remote-state-gcs-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateGcsConfig description: CDKTN Core API Reference for DataTerraformRemoteStateGcsConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/data-terraform-remote-state-http-config.mdx b/content/api-reference/csharp/structs/data-terraform-remote-state-http-config.mdx index ac376f9..f0162fc 100644 --- a/content/api-reference/csharp/structs/data-terraform-remote-state-http-config.mdx +++ b/content/api-reference/csharp/structs/data-terraform-remote-state-http-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateHttpConfig description: CDKTN Core API Reference for DataTerraformRemoteStateHttpConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/data-terraform-remote-state-local-config.mdx b/content/api-reference/csharp/structs/data-terraform-remote-state-local-config.mdx index 7ded58e..a779340 100644 --- a/content/api-reference/csharp/structs/data-terraform-remote-state-local-config.mdx +++ b/content/api-reference/csharp/structs/data-terraform-remote-state-local-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateLocalConfig description: CDKTN Core API Reference for DataTerraformRemoteStateLocalConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/data-terraform-remote-state-oss-config.mdx b/content/api-reference/csharp/structs/data-terraform-remote-state-oss-config.mdx index 26370c4..4f73330 100644 --- a/content/api-reference/csharp/structs/data-terraform-remote-state-oss-config.mdx +++ b/content/api-reference/csharp/structs/data-terraform-remote-state-oss-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateOssConfig description: CDKTN Core API Reference for DataTerraformRemoteStateOssConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/data-terraform-remote-state-pg-config.mdx b/content/api-reference/csharp/structs/data-terraform-remote-state-pg-config.mdx index f7817a0..a7d4d6f 100644 --- a/content/api-reference/csharp/structs/data-terraform-remote-state-pg-config.mdx +++ b/content/api-reference/csharp/structs/data-terraform-remote-state-pg-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStatePgConfig description: CDKTN Core API Reference for DataTerraformRemoteStatePgConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/data-terraform-remote-state-remote-config.mdx b/content/api-reference/csharp/structs/data-terraform-remote-state-remote-config.mdx index 8f75c03..ad516f0 100644 --- a/content/api-reference/csharp/structs/data-terraform-remote-state-remote-config.mdx +++ b/content/api-reference/csharp/structs/data-terraform-remote-state-remote-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateRemoteConfig description: CDKTN Core API Reference for DataTerraformRemoteStateRemoteConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/data-terraform-remote-state-s3-config.mdx b/content/api-reference/csharp/structs/data-terraform-remote-state-s3-config.mdx index 3213897..4c1dfb1 100644 --- a/content/api-reference/csharp/structs/data-terraform-remote-state-s3-config.mdx +++ b/content/api-reference/csharp/structs/data-terraform-remote-state-s3-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateS3Config description: CDKTN Core API Reference for DataTerraformRemoteStateS3Config in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer @@ -62,6 +62,7 @@ new DataTerraformRemoteStateS3Config { string StsRegion = null, string Token = null, bool UseLegacyWorkflow = null, + bool UseLockfile = null, bool UsePathStyle = null, string WorkspaceKeyPrefix = null }; @@ -121,6 +122,7 @@ new DataTerraformRemoteStateS3Config { | StsRegion | string | (Optional) AWS region for STS. | | Token | string | (Optional) Multi-Factor Authentication (MFA) token. | | UseLegacyWorkflow | bool | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. | +| UseLockfile | bool | (Optional) Whether to use a lockfile for locking the state file. | | UsePathStyle | bool | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). | | WorkspaceKeyPrefix | string | (Optional) Prefix applied to the state path inside the bucket. | @@ -329,7 +331,9 @@ This can also be sourced from the AWS\_DYNAMODB\_ENDPOINT environment variable. *** -### `DynamodbTable`Optional +### ~~`DynamodbTable`~~Optional + +- *Deprecated:* Use useLockfile instead, which uses S3 for locking ```csharp public string DynamodbTable { get; set; } @@ -833,6 +837,25 @@ This behavior does not align with the authentication flow of the AWS CLI or SDK' *** +### `UseLockfile`Optional + +```csharp +public bool UseLockfile { get; set; } +``` + +- *Type:* bool + +(Optional) Whether to use a lockfile for locking the state file. + +Defaults to false. +State locking is an opt-in feature of the S3 backend. +Locking can be enabled via S3 or DynamoDB (see dynamodbTable). However, DynamoDB-based locking +is deprecated and will be removed in a future minor version. To support migration from older +versions of Terraform that only support DynamoDB-based locking, the S3 (useLockfile) and DynamoDB +(dynamodbTable) arguments can be configured simultaneously. + +*** + ### `UsePathStyle`Optional ```csharp diff --git a/content/api-reference/csharp/structs/data-terraform-remote-state-swift-config.mdx b/content/api-reference/csharp/structs/data-terraform-remote-state-swift-config.mdx index a10e608..22bd7a1 100644 --- a/content/api-reference/csharp/structs/data-terraform-remote-state-swift-config.mdx +++ b/content/api-reference/csharp/structs/data-terraform-remote-state-swift-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateSwiftConfig description: CDKTN Core API Reference for DataTerraformRemoteStateSwiftConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/encoding-options.mdx b/content/api-reference/csharp/structs/encoding-options.mdx index 36f7772..84d4b52 100644 --- a/content/api-reference/csharp/structs/encoding-options.mdx +++ b/content/api-reference/csharp/structs/encoding-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: EncodingOptions description: CDKTN Core API Reference for EncodingOptions in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Properties to string encodings. diff --git a/content/api-reference/csharp/structs/file-provisioner.mdx b/content/api-reference/csharp/structs/file-provisioner.mdx index 242bc1d..615b22d 100644 --- a/content/api-reference/csharp/structs/file-provisioner.mdx +++ b/content/api-reference/csharp/structs/file-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: FileProvisioner description: CDKTN Core API Reference for FileProvisioner in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The file provisioner copies files or directories from the machine running Terraform to the newly created resource. diff --git a/content/api-reference/csharp/structs/gcs-backend-config.mdx b/content/api-reference/csharp/structs/gcs-backend-config.mdx index 757092d..036ddaa 100644 --- a/content/api-reference/csharp/structs/gcs-backend-config.mdx +++ b/content/api-reference/csharp/structs/gcs-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: GcsBackendConfig description: CDKTN Core API Reference for GcsBackendConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as an object in a configurable prefix in a pre-existing bucket on Google Cloud Storage (GCS). diff --git a/content/api-reference/csharp/structs/http-backend-config.mdx b/content/api-reference/csharp/structs/http-backend-config.mdx index bcd674b..551e16e 100644 --- a/content/api-reference/csharp/structs/http-backend-config.mdx +++ b/content/api-reference/csharp/structs/http-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: HttpBackendConfig description: CDKTN Core API Reference for HttpBackendConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state using a simple REST client. diff --git a/content/api-reference/csharp/structs/lazy-any-value-options.mdx b/content/api-reference/csharp/structs/lazy-any-value-options.mdx index 693fb9c..d5904cf 100644 --- a/content/api-reference/csharp/structs/lazy-any-value-options.mdx +++ b/content/api-reference/csharp/structs/lazy-any-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyAnyValueOptions description: CDKTN Core API Reference for LazyAnyValueOptions in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating lazy untyped tokens. diff --git a/content/api-reference/csharp/structs/lazy-list-value-options.mdx b/content/api-reference/csharp/structs/lazy-list-value-options.mdx index c9e2bbe..759d984 100644 --- a/content/api-reference/csharp/structs/lazy-list-value-options.mdx +++ b/content/api-reference/csharp/structs/lazy-list-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyListValueOptions description: CDKTN Core API Reference for LazyListValueOptions in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating a lazy list token. diff --git a/content/api-reference/csharp/structs/lazy-string-value-options.mdx b/content/api-reference/csharp/structs/lazy-string-value-options.mdx index e3ea4ad..15baef4 100644 --- a/content/api-reference/csharp/structs/lazy-string-value-options.mdx +++ b/content/api-reference/csharp/structs/lazy-string-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyStringValueOptions description: CDKTN Core API Reference for LazyStringValueOptions in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating a lazy string token. diff --git a/content/api-reference/csharp/structs/local-backend-config.mdx b/content/api-reference/csharp/structs/local-backend-config.mdx index 126c3e0..7039f99 100644 --- a/content/api-reference/csharp/structs/local-backend-config.mdx +++ b/content/api-reference/csharp/structs/local-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalBackendConfig description: CDKTN Core API Reference for LocalBackendConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The local backend stores state on the local filesystem, locks that state using system APIs, and performs operations locally. diff --git a/content/api-reference/csharp/structs/local-exec-provisioner.mdx b/content/api-reference/csharp/structs/local-exec-provisioner.mdx index 9543c58..fd68766 100644 --- a/content/api-reference/csharp/structs/local-exec-provisioner.mdx +++ b/content/api-reference/csharp/structs/local-exec-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalExecProvisioner description: CDKTN Core API Reference for LocalExecProvisioner in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The local-exec provisioner invokes a local executable after a resource is created. diff --git a/content/api-reference/csharp/structs/oss-assume-role.mdx b/content/api-reference/csharp/structs/oss-assume-role.mdx index 4457585..acdf9a0 100644 --- a/content/api-reference/csharp/structs/oss-assume-role.mdx +++ b/content/api-reference/csharp/structs/oss-assume-role.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssAssumeRole description: CDKTN Core API Reference for OssAssumeRole in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/oss-backend-config.mdx b/content/api-reference/csharp/structs/oss-backend-config.mdx index 1b4845d..9837b3a 100644 --- a/content/api-reference/csharp/structs/oss-backend-config.mdx +++ b/content/api-reference/csharp/structs/oss-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssBackendConfig description: CDKTN Core API Reference for OssBackendConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/pg-backend-config.mdx b/content/api-reference/csharp/structs/pg-backend-config.mdx index b9611f2..c8a9584 100644 --- a/content/api-reference/csharp/structs/pg-backend-config.mdx +++ b/content/api-reference/csharp/structs/pg-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: PgBackendConfig description: CDKTN Core API Reference for PgBackendConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/postcondition.mdx b/content/api-reference/csharp/structs/postcondition.mdx index 3ce23c9..a5199ac 100644 --- a/content/api-reference/csharp/structs/postcondition.mdx +++ b/content/api-reference/csharp/structs/postcondition.mdx @@ -4,7 +4,7 @@ sidebarTitle: Postcondition description: CDKTN Core API Reference for Postcondition in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Terraform checks a postcondition after evaluating the object it is associated with. diff --git a/content/api-reference/csharp/structs/precondition.mdx b/content/api-reference/csharp/structs/precondition.mdx index c0ee3f3..ac9c65f 100644 --- a/content/api-reference/csharp/structs/precondition.mdx +++ b/content/api-reference/csharp/structs/precondition.mdx @@ -4,7 +4,7 @@ sidebarTitle: Precondition description: CDKTN Core API Reference for Precondition in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Terraform checks a precondition before evaluating the object it is associated with. diff --git a/content/api-reference/csharp/structs/remote-backend-config.mdx b/content/api-reference/csharp/structs/remote-backend-config.mdx index ed7b52a..afbd543 100644 --- a/content/api-reference/csharp/structs/remote-backend-config.mdx +++ b/content/api-reference/csharp/structs/remote-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteBackendConfig description: CDKTN Core API Reference for RemoteBackendConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/remote-exec-provisioner.mdx b/content/api-reference/csharp/structs/remote-exec-provisioner.mdx index f792d24..aa1ca97 100644 --- a/content/api-reference/csharp/structs/remote-exec-provisioner.mdx +++ b/content/api-reference/csharp/structs/remote-exec-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteExecProvisioner description: CDKTN Core API Reference for RemoteExecProvisioner in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The remote-exec provisioner invokes a script on a remote resource after it is created. diff --git a/content/api-reference/csharp/structs/resolve-options.mdx b/content/api-reference/csharp/structs/resolve-options.mdx index c7163e7..21f7ada 100644 --- a/content/api-reference/csharp/structs/resolve-options.mdx +++ b/content/api-reference/csharp/structs/resolve-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: ResolveOptions description: CDKTN Core API Reference for ResolveOptions in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options to the resolve() operation. diff --git a/content/api-reference/csharp/structs/s3-backend-assume-role-config.mdx b/content/api-reference/csharp/structs/s3-backend-assume-role-config.mdx index 582acc8..2d08e1d 100644 --- a/content/api-reference/csharp/structs/s3-backend-assume-role-config.mdx +++ b/content/api-reference/csharp/structs/s3-backend-assume-role-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendAssumeRoleConfig description: CDKTN Core API Reference for S3BackendAssumeRoleConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/s3-backend-assume-role-with-web-identity-config.mdx b/content/api-reference/csharp/structs/s3-backend-assume-role-with-web-identity-config.mdx index aff5d0d..a8afe90 100644 --- a/content/api-reference/csharp/structs/s3-backend-assume-role-with-web-identity-config.mdx +++ b/content/api-reference/csharp/structs/s3-backend-assume-role-with-web-identity-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendAssumeRoleWithWebIdentityConfig description: CDKTN Core API Reference for S3BackendAssumeRoleWithWebIdentityConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/s3-backend-config.mdx b/content/api-reference/csharp/structs/s3-backend-config.mdx index 8199d14..601ed46 100644 --- a/content/api-reference/csharp/structs/s3-backend-config.mdx +++ b/content/api-reference/csharp/structs/s3-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendConfig description: CDKTN Core API Reference for S3BackendConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as a given key in a given bucket on Amazon S3. @@ -76,6 +76,7 @@ new S3BackendConfig { string StsRegion = null, string Token = null, bool UseLegacyWorkflow = null, + bool UseLockfile = null, bool UsePathStyle = null, string WorkspaceKeyPrefix = null }; @@ -133,6 +134,7 @@ new S3BackendConfig { | StsRegion | string | (Optional) AWS region for STS. | | Token | string | (Optional) Multi-Factor Authentication (MFA) token. | | UseLegacyWorkflow | bool | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. | +| UseLockfile | bool | (Optional) Whether to use a lockfile for locking the state file. | | UsePathStyle | bool | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). | | WorkspaceKeyPrefix | string | (Optional) Prefix applied to the state path inside the bucket. | @@ -321,7 +323,9 @@ This can also be sourced from the AWS\_DYNAMODB\_ENDPOINT environment variable. *** -### `DynamodbTable`Optional +### ~~`DynamodbTable`~~Optional + +- *Deprecated:* Use useLockfile instead, which uses S3 for locking ```csharp public string DynamodbTable { get; set; } @@ -825,6 +829,25 @@ This behavior does not align with the authentication flow of the AWS CLI or SDK' *** +### `UseLockfile`Optional + +```csharp +public bool UseLockfile { get; set; } +``` + +- *Type:* bool + +(Optional) Whether to use a lockfile for locking the state file. + +Defaults to false. +State locking is an opt-in feature of the S3 backend. +Locking can be enabled via S3 or DynamoDB (see dynamodbTable). However, DynamoDB-based locking +is deprecated and will be removed in a future minor version. To support migration from older +versions of Terraform that only support DynamoDB-based locking, the S3 (useLockfile) and DynamoDB +(dynamodbTable) arguments can be configured simultaneously. + +*** + ### `UsePathStyle`Optional ```csharp diff --git a/content/api-reference/csharp/structs/s3-backend-endpoint-config.mdx b/content/api-reference/csharp/structs/s3-backend-endpoint-config.mdx index 0899cec..c11bc2e 100644 --- a/content/api-reference/csharp/structs/s3-backend-endpoint-config.mdx +++ b/content/api-reference/csharp/structs/s3-backend-endpoint-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendEndpointConfig description: CDKTN Core API Reference for S3BackendEndpointConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/ssh-provisioner-connection.mdx b/content/api-reference/csharp/structs/ssh-provisioner-connection.mdx index c6c219b..4850122 100644 --- a/content/api-reference/csharp/structs/ssh-provisioner-connection.mdx +++ b/content/api-reference/csharp/structs/ssh-provisioner-connection.mdx @@ -4,7 +4,7 @@ sidebarTitle: SSHProvisionerConnection description: CDKTN Core API Reference for SSHProvisionerConnection in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect. diff --git a/content/api-reference/csharp/structs/stack-annotation.mdx b/content/api-reference/csharp/structs/stack-annotation.mdx index 6ae51b6..034d54e 100644 --- a/content/api-reference/csharp/structs/stack-annotation.mdx +++ b/content/api-reference/csharp/structs/stack-annotation.mdx @@ -4,7 +4,7 @@ sidebarTitle: StackAnnotation description: CDKTN Core API Reference for StackAnnotation in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/stack-manifest.mdx b/content/api-reference/csharp/structs/stack-manifest.mdx index 311d43a..7e88d53 100644 --- a/content/api-reference/csharp/structs/stack-manifest.mdx +++ b/content/api-reference/csharp/structs/stack-manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: StackManifest description: CDKTN Core API Reference for StackManifest in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/swift-backend-config.mdx b/content/api-reference/csharp/structs/swift-backend-config.mdx index 5c3b440..bc553c9 100644 --- a/content/api-reference/csharp/structs/swift-backend-config.mdx +++ b/content/api-reference/csharp/structs/swift-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: SwiftBackendConfig description: CDKTN Core API Reference for SwiftBackendConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-asset-config.mdx b/content/api-reference/csharp/structs/terraform-asset-config.mdx index 7b9fd05..c630eb4 100644 --- a/content/api-reference/csharp/structs/terraform-asset-config.mdx +++ b/content/api-reference/csharp/structs/terraform-asset-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformAssetConfig description: CDKTN Core API Reference for TerraformAssetConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-condition.mdx b/content/api-reference/csharp/structs/terraform-condition.mdx index 2fce6f8..0d55131 100644 --- a/content/api-reference/csharp/structs/terraform-condition.mdx +++ b/content/api-reference/csharp/structs/terraform-condition.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformCondition description: CDKTN Core API Reference for TerraformCondition in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-constructor.mdx b/content/api-reference/csharp/structs/terraform-constructor.mdx index ccb4527..e3644dc 100644 --- a/content/api-reference/csharp/structs/terraform-constructor.mdx +++ b/content/api-reference/csharp/structs/terraform-constructor.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformConstructor description: CDKTN Core API Reference for TerraformConstructor in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-element-metadata.mdx b/content/api-reference/csharp/structs/terraform-element-metadata.mdx index d647e7f..d6884c3 100644 --- a/content/api-reference/csharp/structs/terraform-element-metadata.mdx +++ b/content/api-reference/csharp/structs/terraform-element-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformElementMetadata description: CDKTN Core API Reference for TerraformElementMetadata in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-hcl-module-config.mdx b/content/api-reference/csharp/structs/terraform-hcl-module-config.mdx index 901daa6..1fa4510 100644 --- a/content/api-reference/csharp/structs/terraform-hcl-module-config.mdx +++ b/content/api-reference/csharp/structs/terraform-hcl-module-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformHclModuleConfig description: CDKTN Core API Reference for TerraformHclModuleConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-meta-arguments.mdx b/content/api-reference/csharp/structs/terraform-meta-arguments.mdx index d74374b..45a86f6 100644 --- a/content/api-reference/csharp/structs/terraform-meta-arguments.mdx +++ b/content/api-reference/csharp/structs/terraform-meta-arguments.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformMetaArguments description: CDKTN Core API Reference for TerraformMetaArguments in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-module-config.mdx b/content/api-reference/csharp/structs/terraform-module-config.mdx index a7cc9bc..6769646 100644 --- a/content/api-reference/csharp/structs/terraform-module-config.mdx +++ b/content/api-reference/csharp/structs/terraform-module-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleConfig description: CDKTN Core API Reference for TerraformModuleConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-module-provider.mdx b/content/api-reference/csharp/structs/terraform-module-provider.mdx index ff97e41..743f321 100644 --- a/content/api-reference/csharp/structs/terraform-module-provider.mdx +++ b/content/api-reference/csharp/structs/terraform-module-provider.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleProvider description: CDKTN Core API Reference for TerraformModuleProvider in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-module-user-config.mdx b/content/api-reference/csharp/structs/terraform-module-user-config.mdx index 50f002f..45c2e83 100644 --- a/content/api-reference/csharp/structs/terraform-module-user-config.mdx +++ b/content/api-reference/csharp/structs/terraform-module-user-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleUserConfig description: CDKTN Core API Reference for TerraformModuleUserConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-output-config.mdx b/content/api-reference/csharp/structs/terraform-output-config.mdx index d009c7b..b141c5f 100644 --- a/content/api-reference/csharp/structs/terraform-output-config.mdx +++ b/content/api-reference/csharp/structs/terraform-output-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformOutputConfig description: CDKTN Core API Reference for TerraformOutputConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-provider-config.mdx b/content/api-reference/csharp/structs/terraform-provider-config.mdx index 88d5d13..525b4b3 100644 --- a/content/api-reference/csharp/structs/terraform-provider-config.mdx +++ b/content/api-reference/csharp/structs/terraform-provider-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProviderConfig description: CDKTN Core API Reference for TerraformProviderConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-provider-generator-metadata.mdx b/content/api-reference/csharp/structs/terraform-provider-generator-metadata.mdx index fb740f2..4a1d9cc 100644 --- a/content/api-reference/csharp/structs/terraform-provider-generator-metadata.mdx +++ b/content/api-reference/csharp/structs/terraform-provider-generator-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProviderGeneratorMetadata description: CDKTN Core API Reference for TerraformProviderGeneratorMetadata in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-resource-config.mdx b/content/api-reference/csharp/structs/terraform-resource-config.mdx index 2500c56..b7529f0 100644 --- a/content/api-reference/csharp/structs/terraform-resource-config.mdx +++ b/content/api-reference/csharp/structs/terraform-resource-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceConfig description: CDKTN Core API Reference for TerraformResourceConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-resource-import.mdx b/content/api-reference/csharp/structs/terraform-resource-import.mdx index fa6894c..5365806 100644 --- a/content/api-reference/csharp/structs/terraform-resource-import.mdx +++ b/content/api-reference/csharp/structs/terraform-resource-import.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceImport description: CDKTN Core API Reference for TerraformResourceImport in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-resource-lifecycle.mdx b/content/api-reference/csharp/structs/terraform-resource-lifecycle.mdx index a45b6b0..52ee04e 100644 --- a/content/api-reference/csharp/structs/terraform-resource-lifecycle.mdx +++ b/content/api-reference/csharp/structs/terraform-resource-lifecycle.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceLifecycle description: CDKTN Core API Reference for TerraformResourceLifecycle in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-resource-move-by-id.mdx b/content/api-reference/csharp/structs/terraform-resource-move-by-id.mdx index 85d3d84..8e1da91 100644 --- a/content/api-reference/csharp/structs/terraform-resource-move-by-id.mdx +++ b/content/api-reference/csharp/structs/terraform-resource-move-by-id.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceMoveById description: CDKTN Core API Reference for TerraformResourceMoveById in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-resource-move-by-target.mdx b/content/api-reference/csharp/structs/terraform-resource-move-by-target.mdx index 91df33c..7061419 100644 --- a/content/api-reference/csharp/structs/terraform-resource-move-by-target.mdx +++ b/content/api-reference/csharp/structs/terraform-resource-move-by-target.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceMoveByTarget description: CDKTN Core API Reference for TerraformResourceMoveByTarget in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-stack-metadata.mdx b/content/api-reference/csharp/structs/terraform-stack-metadata.mdx index 8bd62bf..f23ad3d 100644 --- a/content/api-reference/csharp/structs/terraform-stack-metadata.mdx +++ b/content/api-reference/csharp/structs/terraform-stack-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformStackMetadata description: CDKTN Core API Reference for TerraformStackMetadata in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-variable-config.mdx b/content/api-reference/csharp/structs/terraform-variable-config.mdx index 32b7bc3..93069e0 100644 --- a/content/api-reference/csharp/structs/terraform-variable-config.mdx +++ b/content/api-reference/csharp/structs/terraform-variable-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariableConfig description: CDKTN Core API Reference for TerraformVariableConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/terraform-variable-validation-config.mdx b/content/api-reference/csharp/structs/terraform-variable-validation-config.mdx index 80d7273..8bcc351 100644 --- a/content/api-reference/csharp/structs/terraform-variable-validation-config.mdx +++ b/content/api-reference/csharp/structs/terraform-variable-validation-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariableValidationConfig description: CDKTN Core API Reference for TerraformVariableValidationConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Add one or more validation blocks within the variable block to specify custom conditions. diff --git a/content/api-reference/csharp/structs/testing-app-config.mdx b/content/api-reference/csharp/structs/testing-app-config.mdx index d58dd6c..fdd5969 100644 --- a/content/api-reference/csharp/structs/testing-app-config.mdx +++ b/content/api-reference/csharp/structs/testing-app-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TestingAppConfig description: CDKTN Core API Reference for TestingAppConfig in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/csharp/structs/winrm-provisioner-connection.mdx b/content/api-reference/csharp/structs/winrm-provisioner-connection.mdx index 3dbd2b2..00ebf6c 100644 --- a/content/api-reference/csharp/structs/winrm-provisioner-connection.mdx +++ b/content/api-reference/csharp/structs/winrm-provisioner-connection.mdx @@ -4,7 +4,7 @@ sidebarTitle: WinrmProvisionerConnection description: CDKTN Core API Reference for WinrmProvisionerConnection in CSharp. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect. diff --git a/content/api-reference/go/classes/annotations.mdx b/content/api-reference/go/classes/annotations.mdx index c42e672..88654bf 100644 --- a/content/api-reference/go/classes/annotations.mdx +++ b/content/api-reference/go/classes/annotations.mdx @@ -4,7 +4,7 @@ sidebarTitle: Annotations description: CDKTN Core API Reference for Annotations in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Includes API for attaching annotations such as warning messages to constructs. diff --git a/content/api-reference/go/classes/any-list-list.mdx b/content/api-reference/go/classes/any-list-list.mdx index 7c24959..e71e41f 100644 --- a/content/api-reference/go/classes/any-list-list.mdx +++ b/content/api-reference/go/classes/any-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyListList description: CDKTN Core API Reference for AnyListList in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/any-list-map.mdx b/content/api-reference/go/classes/any-list-map.mdx index 6e598d0..765d2ad 100644 --- a/content/api-reference/go/classes/any-list-map.mdx +++ b/content/api-reference/go/classes/any-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyListMap description: CDKTN Core API Reference for AnyListMap in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/any-map-list.mdx b/content/api-reference/go/classes/any-map-list.mdx index 9638c37..8c1697f 100644 --- a/content/api-reference/go/classes/any-map-list.mdx +++ b/content/api-reference/go/classes/any-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyMapList description: CDKTN Core API Reference for AnyMapList in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/any-map.mdx b/content/api-reference/go/classes/any-map.mdx index eaefc2c..b438bb0 100644 --- a/content/api-reference/go/classes/any-map.mdx +++ b/content/api-reference/go/classes/any-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyMap description: CDKTN Core API Reference for AnyMap in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/go/classes/aspects.mdx b/content/api-reference/go/classes/aspects.mdx index 608cb29..5c2fcac 100644 --- a/content/api-reference/go/classes/aspects.mdx +++ b/content/api-reference/go/classes/aspects.mdx @@ -4,7 +4,7 @@ sidebarTitle: Aspects description: CDKTN Core API Reference for Aspects in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis. diff --git a/content/api-reference/go/classes/assertion-return.mdx b/content/api-reference/go/classes/assertion-return.mdx index 832c51c..ddc2802 100644 --- a/content/api-reference/go/classes/assertion-return.mdx +++ b/content/api-reference/go/classes/assertion-return.mdx @@ -4,7 +4,7 @@ sidebarTitle: AssertionReturn description: CDKTN Core API Reference for AssertionReturn in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Class representing the contents of a return by an assertion. diff --git a/content/api-reference/go/classes/boolean-list-list.mdx b/content/api-reference/go/classes/boolean-list-list.mdx index cc74ed2..4403ff4 100644 --- a/content/api-reference/go/classes/boolean-list-list.mdx +++ b/content/api-reference/go/classes/boolean-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanListList description: CDKTN Core API Reference for BooleanListList in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/boolean-list-map.mdx b/content/api-reference/go/classes/boolean-list-map.mdx index 049ef1f..4d6c7e4 100644 --- a/content/api-reference/go/classes/boolean-list-map.mdx +++ b/content/api-reference/go/classes/boolean-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanListMap description: CDKTN Core API Reference for BooleanListMap in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/boolean-list.mdx b/content/api-reference/go/classes/boolean-list.mdx index 3fcbf81..c18780e 100644 --- a/content/api-reference/go/classes/boolean-list.mdx +++ b/content/api-reference/go/classes/boolean-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanList description: CDKTN Core API Reference for BooleanList in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/boolean-map-list.mdx b/content/api-reference/go/classes/boolean-map-list.mdx index 8f5cb69..981b347 100644 --- a/content/api-reference/go/classes/boolean-map-list.mdx +++ b/content/api-reference/go/classes/boolean-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanMapList description: CDKTN Core API Reference for BooleanMapList in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/boolean-map.mdx b/content/api-reference/go/classes/boolean-map.mdx index 969cd2d..5ad469b 100644 --- a/content/api-reference/go/classes/boolean-map.mdx +++ b/content/api-reference/go/classes/boolean-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanMap description: CDKTN Core API Reference for BooleanMap in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/go/classes/cloud-workspace.mdx b/content/api-reference/go/classes/cloud-workspace.mdx index 54b05f6..141153e 100644 --- a/content/api-reference/go/classes/cloud-workspace.mdx +++ b/content/api-reference/go/classes/cloud-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudWorkspace description: CDKTN Core API Reference for CloudWorkspace in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} A cloud workspace can either be a single named workspace, or a list of tagged workspaces. diff --git a/content/api-reference/go/classes/complex-computed-list.mdx b/content/api-reference/go/classes/complex-computed-list.mdx index 3982c02..b0fe386 100644 --- a/content/api-reference/go/classes/complex-computed-list.mdx +++ b/content/api-reference/go/classes/complex-computed-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexComputedList description: CDKTN Core API Reference for ComplexComputedList in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IInterpolatingParent, IResolvable, ITerraformAddressable diff --git a/content/api-reference/go/classes/complex-list.mdx b/content/api-reference/go/classes/complex-list.mdx index 6f98d20..36bdf55 100644 --- a/content/api-reference/go/classes/complex-list.mdx +++ b/content/api-reference/go/classes/complex-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexList description: CDKTN Core API Reference for ComplexList in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/go/classes/complex-map.mdx b/content/api-reference/go/classes/complex-map.mdx index c040ce7..69e0892 100644 --- a/content/api-reference/go/classes/complex-map.mdx +++ b/content/api-reference/go/classes/complex-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexMap description: CDKTN Core API Reference for ComplexMap in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/go/classes/complex-object.mdx b/content/api-reference/go/classes/complex-object.mdx index 13d75a2..1074b38 100644 --- a/content/api-reference/go/classes/complex-object.mdx +++ b/content/api-reference/go/classes/complex-object.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexObject description: CDKTN Core API Reference for ComplexObject in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IInterpolatingParent, IResolvable, ITerraformAddressable diff --git a/content/api-reference/go/classes/default-token-resolver.mdx b/content/api-reference/go/classes/default-token-resolver.mdx index e7fc6dd..1ed06c7 100644 --- a/content/api-reference/go/classes/default-token-resolver.mdx +++ b/content/api-reference/go/classes/default-token-resolver.mdx @@ -4,7 +4,7 @@ sidebarTitle: DefaultTokenResolver description: CDKTN Core API Reference for DefaultTokenResolver in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITokenResolver diff --git a/content/api-reference/go/classes/dynamic-list-terraform-iterator.mdx b/content/api-reference/go/classes/dynamic-list-terraform-iterator.mdx index 0aee683..7452c70 100644 --- a/content/api-reference/go/classes/dynamic-list-terraform-iterator.mdx +++ b/content/api-reference/go/classes/dynamic-list-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: DynamicListTerraformIterator description: CDKTN Core API Reference for DynamicListTerraformIterator in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/fn-generated.mdx b/content/api-reference/go/classes/fn-generated.mdx index 4d7ed0e..d70c621 100644 --- a/content/api-reference/go/classes/fn-generated.mdx +++ b/content/api-reference/go/classes/fn-generated.mdx @@ -4,7 +4,7 @@ sidebarTitle: FnGenerated description: CDKTN Core API Reference for FnGenerated in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -29,6 +29,7 @@ cdktn.NewFnGenerated() FnGenerated | Anytrue | [anytrue](https://developer.hashicorp.com/terraform/language/functions/anytrue) returns `true` if any element in a given collection is `true` or `"true"`. It also returns `false` if the collection is empty. | | Base64decode | [base64decode](https://developer.hashicorp.com/terraform/language/functions/base64decode) takes a string containing a Base64 character sequence and returns the original string. | | Base64encode | [base64encode](https://developer.hashicorp.com/terraform/language/functions/base64encode) applies Base64 encoding to a string. | +| Base64gunzip | [base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. | | Base64gzip | [base64gzip](https://developer.hashicorp.com/terraform/language/functions/base64gzip) compresses a string with gzip and then encodes the result in Base64 encoding. | | Base64sha256 | [base64sha256](https://developer.hashicorp.com/terraform/language/functions/base64sha256) computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()` returns hexadecimal representation. | | Base64sha512 | [base64sha512](https://developer.hashicorp.com/terraform/language/functions/base64sha512) computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha512("test"))` since `sha512()` returns hexadecimal representation. | @@ -37,6 +38,7 @@ cdktn.NewFnGenerated() FnGenerated | Ceil | [ceil](https://developer.hashicorp.com/terraform/language/functions/ceil) returns the closest whole number that is greater than or equal to the given value, which may be a fraction. | | Chomp | [chomp](https://developer.hashicorp.com/terraform/language/functions/chomp) removes newline characters at the end of a string. | | Chunklist | [chunklist](https://developer.hashicorp.com/terraform/language/functions/chunklist) splits a single list into fixed-size chunks, returning a list of lists. | +| Cidrcontains | [cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. | | Cidrhost | [cidrhost](https://developer.hashicorp.com/terraform/language/functions/cidrhost) calculates a full host IP address for a given host number within a given IP network address prefix. | | Cidrnetmask | [cidrnetmask](https://developer.hashicorp.com/terraform/language/functions/cidrnetmask) converts an IPv4 address prefix given in CIDR notation into a subnet mask address. | | Cidrsubnet | [cidrsubnet](https://developer.hashicorp.com/terraform/language/functions/cidrsubnet) calculates a subnet address within given IP network address prefix. | @@ -46,11 +48,13 @@ cdktn.NewFnGenerated() FnGenerated | Compact | [compact](https://developer.hashicorp.com/terraform/language/functions/compact) takes a list of strings and returns a new list with any empty string elements removed. | | Concat | [concat](https://developer.hashicorp.com/terraform/language/functions/concat) takes two or more lists and combines them into a single list. | | Contains | [contains](https://developer.hashicorp.com/terraform/language/functions/contains) determines whether a given list or set contains a given single value as one of its elements. | +| Convert | [convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. | | Csvdecode | [csvdecode](https://developer.hashicorp.com/terraform/language/functions/csvdecode) decodes a string containing CSV-formatted data and produces a list of maps representing that data. | | Dirname | [dirname](https://developer.hashicorp.com/terraform/language/functions/dirname) takes a string containing a filesystem path and removes the last portion from it. | | Distinct | [distinct](https://developer.hashicorp.com/terraform/language/functions/distinct) takes a list and returns a new list with any duplicate elements removed. | | Element | [element](https://developer.hashicorp.com/terraform/language/functions/element) retrieves a single element from a list. | | Endswith | [endswith](https://developer.hashicorp.com/terraform/language/functions/endswith) takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix. | +| Ephemeralasnull | [ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. | | File | [file](https://developer.hashicorp.com/terraform/language/functions/file) reads the contents of a file at the given path and returns them as a string. | | Filebase64 | [filebase64](https://developer.hashicorp.com/terraform/language/functions/filebase64) reads the contents of a file at the given path and returns them as a base64-encoded string. | | Filebase64sha256 | [filebase64sha256](https://developer.hashicorp.com/terraform/language/functions/filebase64sha256) is a variant of `base64sha256` that hashes the contents of a given file rather than a literal string. | @@ -68,6 +72,7 @@ cdktn.NewFnGenerated() FnGenerated | Formatlist | [formatlist](https://developer.hashicorp.com/terraform/language/functions/formatlist) produces a list of strings by formatting a number of other values according to a specification string. | | Indent | [indent](https://developer.hashicorp.com/terraform/language/functions/indent) adds a given number of spaces to the beginnings of all but the first line in a given multi-line string. | | Index | [index](https://developer.hashicorp.com/terraform/language/functions/index) finds the element index for a given value in a list. | +| Issensitive | [issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. | | Jsondecode | [jsondecode](https://developer.hashicorp.com/terraform/language/functions/jsondecode) interprets a given string as JSON, returning a representation of the result of decoding that string. | | Jsonencode | [jsonencode](https://developer.hashicorp.com/terraform/language/functions/jsonencode) encodes a given value to a string using JSON syntax. | | Keys | [keys](https://developer.hashicorp.com/terraform/language/functions/keys) takes a map and returns a list containing the keys from that map. | @@ -108,6 +113,7 @@ cdktn.NewFnGenerated() FnGenerated | Substr | [substr](https://developer.hashicorp.com/terraform/language/functions/substr) extracts a substring from a given string by offset and (maximum) length. | | Sum | [sum](https://developer.hashicorp.com/terraform/language/functions/sum) takes a list or set of numbers and returns the sum of those numbers. | | Templatefile | [templatefile](https://developer.hashicorp.com/terraform/language/functions/templatefile) reads the file at the given path and renders its content as a template using a supplied set of template variables. | +| Templatestring | [templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. | | Textdecodebase64 | [textdecodebase64](https://developer.hashicorp.com/terraform/language/functions/textdecodebase64) function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding. | | Textencodebase64 | [textencodebase64](https://developer.hashicorp.com/terraform/language/functions/textencodebase64) encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters. | | Timeadd | [timeadd](https://developer.hashicorp.com/terraform/language/functions/timeadd) adds a duration to a timestamp, returning a new timestamp. | @@ -127,6 +133,7 @@ cdktn.NewFnGenerated() FnGenerated | Trimsuffix | [trimsuffix](https://developer.hashicorp.com/terraform/language/functions/trimsuffix) removes the specified suffix from the end of the given string. | | Try | [try](https://developer.hashicorp.com/terraform/language/functions/try) evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors. | | Upper | [upper](https://developer.hashicorp.com/terraform/language/functions/upper) converts all cased letters in the given string to uppercase. | +| Urldecode | [urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. | | Urlencode | [urlencode](https://developer.hashicorp.com/terraform/language/functions/urlencode) applies URL encoding to a given string. | | Uuid | [uuid](https://developer.hashicorp.com/terraform/language/functions/uuid) generates a unique identifier string. | | Uuidv5 | [uuidv5](https://developer.hashicorp.com/terraform/language/functions/uuidv5) generates a *name-based* UUID, as described in [RFC 4122 section 4.3](https://tools.ietf.org/html/rfc4122#section-4.3), also known as a "version 5" UUID. | @@ -233,6 +240,22 @@ cdktn.FnGenerated_Base64encode(str *string) *string *** +### `Base64gunzip` + +```go +import "github.com/open-constructs/cdk-terrain-go/cdktn" + +cdktn.FnGenerated_Base64gunzip(str *string) *string +``` + +[base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. + +#### `str`Required + +- *Type:* \*string + +*** + ### `Base64gzip` ```go @@ -367,6 +390,28 @@ cdktn.FnGenerated_Chunklist(list *[]interface{}, size *f64) *[]*string *** +### `Cidrcontains` + +```go +import "github.com/open-constructs/cdk-terrain-go/cdktn" + +cdktn.FnGenerated_Cidrcontains(containing_prefix *string, contained_ip_or_prefix *string) IResolvable +``` + +[cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. + +#### `containing_prefix`Required + +- *Type:* \*string + +*** + +#### `contained_ip_or_prefix`Required + +- *Type:* \*string + +*** + ### `Cidrhost` ```go @@ -541,6 +586,28 @@ cdktn.FnGenerated_Contains(list interface{}, value interface{}) interface{} *** +### `Convert` + +```go +import "github.com/open-constructs/cdk-terrain-go/cdktn" + +cdktn.FnGenerated_Convert(value interface{}, type interface{}) interface{} +``` + +[convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. + +#### `value`Required + +- *Type:* interface\{} + +*** + +#### `type`Required + +- *Type:* interface\{} + +*** + ### `Csvdecode` ```go @@ -633,6 +700,22 @@ cdktn.FnGenerated_Endswith(str *string, suffix *string) IResolvable *** +### `Ephemeralasnull` + +```go +import "github.com/open-constructs/cdk-terrain-go/cdktn" + +cdktn.FnGenerated_Ephemeralasnull(value interface{}) interface{} +``` + +[ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. + +#### `value`Required + +- *Type:* interface\{} + +*** + ### `File` ```go @@ -836,7 +919,7 @@ cdktn.FnGenerated_Floor(num *f64) *f64 ```go import "github.com/open-constructs/cdk-terrain-go/cdktn" -cdktn.FnGenerated_Format(format *string, args *[]interface{}) interface{} +cdktn.FnGenerated_Format(format *string, args *[]interface{}) *string ``` The [format](https://developer.hashicorp.com/terraform/language/functions/format) function produces a string by formatting a number of other values according to a specification string. It is similar to the `printf` function in C, and other similar functions in other programming languages. @@ -880,7 +963,7 @@ cdktn.FnGenerated_Formatdate(format *string, time *string) *string ```go import "github.com/open-constructs/cdk-terrain-go/cdktn" -cdktn.FnGenerated_Formatlist(format *string, args *[]interface{}) interface{} +cdktn.FnGenerated_Formatlist(format *string, args *[]interface{}) *[]*string ``` [formatlist](https://developer.hashicorp.com/terraform/language/functions/formatlist) produces a list of strings by formatting a number of other values according to a specification string. @@ -941,6 +1024,22 @@ cdktn.FnGenerated_Index(list interface{}, value interface{}) interface{} *** +### `Issensitive` + +```go +import "github.com/open-constructs/cdk-terrain-go/cdktn" + +cdktn.FnGenerated_Issensitive(value interface{}) IResolvable +``` + +[issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. + +#### `value`Required + +- *Type:* interface\{} + +*** + ### `Jsondecode` ```go @@ -1701,6 +1800,28 @@ cdktn.FnGenerated_Templatefile(path *string, vars interface{}) interface{} *** +### `Templatestring` + +```go +import "github.com/open-constructs/cdk-terrain-go/cdktn" + +cdktn.FnGenerated_Templatestring(template *string, vars interface{}) *string +``` + +[templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. + +#### `template`Required + +- *Type:* \*string + +*** + +#### `vars`Required + +- *Type:* interface\{} + +*** + ### `Textdecodebase64` ```go @@ -2041,6 +2162,22 @@ cdktn.FnGenerated_Upper(str *string) *string *** +### `Urldecode` + +```go +import "github.com/open-constructs/cdk-terrain-go/cdktn" + +cdktn.FnGenerated_Urldecode(str *string) *string +``` + +[urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. + +#### `str`Required + +- *Type:* \*string + +*** + ### `Urlencode` ```go diff --git a/content/api-reference/go/classes/fn.mdx b/content/api-reference/go/classes/fn.mdx index dcb18f2..b2c3abd 100644 --- a/content/api-reference/go/classes/fn.mdx +++ b/content/api-reference/go/classes/fn.mdx @@ -4,7 +4,7 @@ sidebarTitle: Fn description: CDKTN Core API Reference for Fn in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -29,6 +29,7 @@ cdktn.NewFn() Fn | Anytrue | [anytrue](https://developer.hashicorp.com/terraform/language/functions/anytrue) returns `true` if any element in a given collection is `true` or `"true"`. It also returns `false` if the collection is empty. | | Base64decode | [base64decode](https://developer.hashicorp.com/terraform/language/functions/base64decode) takes a string containing a Base64 character sequence and returns the original string. | | Base64encode | [base64encode](https://developer.hashicorp.com/terraform/language/functions/base64encode) applies Base64 encoding to a string. | +| Base64gunzip | [base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. | | Base64gzip | [base64gzip](https://developer.hashicorp.com/terraform/language/functions/base64gzip) compresses a string with gzip and then encodes the result in Base64 encoding. | | Base64sha256 | [base64sha256](https://developer.hashicorp.com/terraform/language/functions/base64sha256) computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()` returns hexadecimal representation. | | Base64sha512 | [base64sha512](https://developer.hashicorp.com/terraform/language/functions/base64sha512) computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha512("test"))` since `sha512()` returns hexadecimal representation. | @@ -37,6 +38,7 @@ cdktn.NewFn() Fn | Ceil | [ceil](https://developer.hashicorp.com/terraform/language/functions/ceil) returns the closest whole number that is greater than or equal to the given value, which may be a fraction. | | Chomp | [chomp](https://developer.hashicorp.com/terraform/language/functions/chomp) removes newline characters at the end of a string. | | Chunklist | [chunklist](https://developer.hashicorp.com/terraform/language/functions/chunklist) splits a single list into fixed-size chunks, returning a list of lists. | +| Cidrcontains | [cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. | | Cidrhost | [cidrhost](https://developer.hashicorp.com/terraform/language/functions/cidrhost) calculates a full host IP address for a given host number within a given IP network address prefix. | | Cidrnetmask | [cidrnetmask](https://developer.hashicorp.com/terraform/language/functions/cidrnetmask) converts an IPv4 address prefix given in CIDR notation into a subnet mask address. | | Cidrsubnet | [cidrsubnet](https://developer.hashicorp.com/terraform/language/functions/cidrsubnet) calculates a subnet address within given IP network address prefix. | @@ -46,11 +48,13 @@ cdktn.NewFn() Fn | Compact | [compact](https://developer.hashicorp.com/terraform/language/functions/compact) takes a list of strings and returns a new list with any empty string elements removed. | | Concat | [concat](https://developer.hashicorp.com/terraform/language/functions/concat) takes two or more lists and combines them into a single list. | | Contains | [contains](https://developer.hashicorp.com/terraform/language/functions/contains) determines whether a given list or set contains a given single value as one of its elements. | +| Convert | [convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. | | Csvdecode | [csvdecode](https://developer.hashicorp.com/terraform/language/functions/csvdecode) decodes a string containing CSV-formatted data and produces a list of maps representing that data. | | Dirname | [dirname](https://developer.hashicorp.com/terraform/language/functions/dirname) takes a string containing a filesystem path and removes the last portion from it. | | Distinct | [distinct](https://developer.hashicorp.com/terraform/language/functions/distinct) takes a list and returns a new list with any duplicate elements removed. | | Element | [element](https://developer.hashicorp.com/terraform/language/functions/element) retrieves a single element from a list. | | Endswith | [endswith](https://developer.hashicorp.com/terraform/language/functions/endswith) takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix. | +| Ephemeralasnull | [ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. | | File | [file](https://developer.hashicorp.com/terraform/language/functions/file) reads the contents of a file at the given path and returns them as a string. | | Filebase64 | [filebase64](https://developer.hashicorp.com/terraform/language/functions/filebase64) reads the contents of a file at the given path and returns them as a base64-encoded string. | | Filebase64sha256 | [filebase64sha256](https://developer.hashicorp.com/terraform/language/functions/filebase64sha256) is a variant of `base64sha256` that hashes the contents of a given file rather than a literal string. | @@ -68,6 +72,7 @@ cdktn.NewFn() Fn | Formatlist | [formatlist](https://developer.hashicorp.com/terraform/language/functions/formatlist) produces a list of strings by formatting a number of other values according to a specification string. | | Indent | [indent](https://developer.hashicorp.com/terraform/language/functions/indent) adds a given number of spaces to the beginnings of all but the first line in a given multi-line string. | | Index | [index](https://developer.hashicorp.com/terraform/language/functions/index) finds the element index for a given value in a list. | +| Issensitive | [issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. | | Jsondecode | [jsondecode](https://developer.hashicorp.com/terraform/language/functions/jsondecode) interprets a given string as JSON, returning a representation of the result of decoding that string. | | Jsonencode | [jsonencode](https://developer.hashicorp.com/terraform/language/functions/jsonencode) encodes a given value to a string using JSON syntax. | | Keys | [keys](https://developer.hashicorp.com/terraform/language/functions/keys) takes a map and returns a list containing the keys from that map. | @@ -108,6 +113,7 @@ cdktn.NewFn() Fn | Substr | [substr](https://developer.hashicorp.com/terraform/language/functions/substr) extracts a substring from a given string by offset and (maximum) length. | | Sum | [sum](https://developer.hashicorp.com/terraform/language/functions/sum) takes a list or set of numbers and returns the sum of those numbers. | | Templatefile | [templatefile](https://developer.hashicorp.com/terraform/language/functions/templatefile) reads the file at the given path and renders its content as a template using a supplied set of template variables. | +| Templatestring | [templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. | | Textdecodebase64 | [textdecodebase64](https://developer.hashicorp.com/terraform/language/functions/textdecodebase64) function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding. | | Textencodebase64 | [textencodebase64](https://developer.hashicorp.com/terraform/language/functions/textencodebase64) encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters. | | Timeadd | [timeadd](https://developer.hashicorp.com/terraform/language/functions/timeadd) adds a duration to a timestamp, returning a new timestamp. | @@ -127,6 +133,7 @@ cdktn.NewFn() Fn | Trimsuffix | [trimsuffix](https://developer.hashicorp.com/terraform/language/functions/trimsuffix) removes the specified suffix from the end of the given string. | | Try | [try](https://developer.hashicorp.com/terraform/language/functions/try) evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors. | | Upper | [upper](https://developer.hashicorp.com/terraform/language/functions/upper) converts all cased letters in the given string to uppercase. | +| Urldecode | [urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. | | Urlencode | [urlencode](https://developer.hashicorp.com/terraform/language/functions/urlencode) applies URL encoding to a given string. | | Uuid | [uuid](https://developer.hashicorp.com/terraform/language/functions/uuid) generates a unique identifier string. | | Uuidv5 | [uuidv5](https://developer.hashicorp.com/terraform/language/functions/uuidv5) generates a *name-based* UUID, as described in [RFC 4122 section 4.3](https://tools.ietf.org/html/rfc4122#section-4.3), also known as a "version 5" UUID. | @@ -240,6 +247,22 @@ cdktn.Fn_Base64encode(str *string) *string *** +### `Base64gunzip` + +```go +import "github.com/open-constructs/cdk-terrain-go/cdktn" + +cdktn.Fn_Base64gunzip(str *string) *string +``` + +[base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. + +#### `str`Required + +- *Type:* \*string + +*** + ### `Base64gzip` ```go @@ -374,6 +397,28 @@ cdktn.Fn_Chunklist(list *[]interface{}, size *f64) *[]*string *** +### `Cidrcontains` + +```go +import "github.com/open-constructs/cdk-terrain-go/cdktn" + +cdktn.Fn_Cidrcontains(containing_prefix *string, contained_ip_or_prefix *string) IResolvable +``` + +[cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. + +#### `containing_prefix`Required + +- *Type:* \*string + +*** + +#### `contained_ip_or_prefix`Required + +- *Type:* \*string + +*** + ### `Cidrhost` ```go @@ -548,6 +593,28 @@ cdktn.Fn_Contains(list interface{}, value interface{}) interface{} *** +### `Convert` + +```go +import "github.com/open-constructs/cdk-terrain-go/cdktn" + +cdktn.Fn_Convert(value interface{}, type interface{}) interface{} +``` + +[convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. + +#### `value`Required + +- *Type:* interface\{} + +*** + +#### `type`Required + +- *Type:* interface\{} + +*** + ### `Csvdecode` ```go @@ -640,6 +707,22 @@ cdktn.Fn_Endswith(str *string, suffix *string) IResolvable *** +### `Ephemeralasnull` + +```go +import "github.com/open-constructs/cdk-terrain-go/cdktn" + +cdktn.Fn_Ephemeralasnull(value interface{}) interface{} +``` + +[ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. + +#### `value`Required + +- *Type:* interface\{} + +*** + ### `File` ```go @@ -843,7 +926,7 @@ cdktn.Fn_Floor(num *f64) *f64 ```go import "github.com/open-constructs/cdk-terrain-go/cdktn" -cdktn.Fn_Format(format *string, args *[]interface{}) interface{} +cdktn.Fn_Format(format *string, args *[]interface{}) *string ``` The [format](https://developer.hashicorp.com/terraform/language/functions/format) function produces a string by formatting a number of other values according to a specification string. It is similar to the `printf` function in C, and other similar functions in other programming languages. @@ -887,7 +970,7 @@ cdktn.Fn_Formatdate(format *string, time *string) *string ```go import "github.com/open-constructs/cdk-terrain-go/cdktn" -cdktn.Fn_Formatlist(format *string, args *[]interface{}) interface{} +cdktn.Fn_Formatlist(format *string, args *[]interface{}) *[]*string ``` [formatlist](https://developer.hashicorp.com/terraform/language/functions/formatlist) produces a list of strings by formatting a number of other values according to a specification string. @@ -948,6 +1031,22 @@ cdktn.Fn_Index(list interface{}, value interface{}) interface{} *** +### `Issensitive` + +```go +import "github.com/open-constructs/cdk-terrain-go/cdktn" + +cdktn.Fn_Issensitive(value interface{}) IResolvable +``` + +[issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. + +#### `value`Required + +- *Type:* interface\{} + +*** + ### `Jsondecode` ```go @@ -1708,6 +1807,28 @@ cdktn.Fn_Templatefile(path *string, vars interface{}) interface{} *** +### `Templatestring` + +```go +import "github.com/open-constructs/cdk-terrain-go/cdktn" + +cdktn.Fn_Templatestring(template *string, vars interface{}) *string +``` + +[templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. + +#### `template`Required + +- *Type:* \*string + +*** + +#### `vars`Required + +- *Type:* interface\{} + +*** + ### `Textdecodebase64` ```go @@ -2048,6 +2169,22 @@ cdktn.Fn_Upper(str *string) *string *** +### `Urldecode` + +```go +import "github.com/open-constructs/cdk-terrain-go/cdktn" + +cdktn.Fn_Urldecode(str *string) *string +``` + +[urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. + +#### `str`Required + +- *Type:* \*string + +*** + ### `Urlencode` ```go diff --git a/content/api-reference/go/classes/lazy-base.mdx b/content/api-reference/go/classes/lazy-base.mdx index 48b3595..cc9b1a6 100644 --- a/content/api-reference/go/classes/lazy-base.mdx +++ b/content/api-reference/go/classes/lazy-base.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyBase description: CDKTN Core API Reference for LazyBase in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IResolvable diff --git a/content/api-reference/go/classes/lazy.mdx b/content/api-reference/go/classes/lazy.mdx index 3dd3121..c4628da 100644 --- a/content/api-reference/go/classes/lazy.mdx +++ b/content/api-reference/go/classes/lazy.mdx @@ -4,7 +4,7 @@ sidebarTitle: Lazy description: CDKTN Core API Reference for Lazy in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Lazily produce a value. diff --git a/content/api-reference/go/classes/list-terraform-iterator.mdx b/content/api-reference/go/classes/list-terraform-iterator.mdx index 1a14c38..a26911c 100644 --- a/content/api-reference/go/classes/list-terraform-iterator.mdx +++ b/content/api-reference/go/classes/list-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ListTerraformIterator description: CDKTN Core API Reference for ListTerraformIterator in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/manifest.mdx b/content/api-reference/go/classes/manifest.mdx index 624762b..3640733 100644 --- a/content/api-reference/go/classes/manifest.mdx +++ b/content/api-reference/go/classes/manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: Manifest description: CDKTN Core API Reference for Manifest in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IManifest diff --git a/content/api-reference/go/classes/map-list.mdx b/content/api-reference/go/classes/map-list.mdx index dc76fc0..3deed40 100644 --- a/content/api-reference/go/classes/map-list.mdx +++ b/content/api-reference/go/classes/map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: MapList description: CDKTN Core API Reference for MapList in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IInterpolatingParent, IResolvable diff --git a/content/api-reference/go/classes/map-terraform-iterator.mdx b/content/api-reference/go/classes/map-terraform-iterator.mdx index a6ca06f..d3898e2 100644 --- a/content/api-reference/go/classes/map-terraform-iterator.mdx +++ b/content/api-reference/go/classes/map-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: MapTerraformIterator description: CDKTN Core API Reference for MapTerraformIterator in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/migrate-ids.mdx b/content/api-reference/go/classes/migrate-ids.mdx index 4f0afad..6bc58e2 100644 --- a/content/api-reference/go/classes/migrate-ids.mdx +++ b/content/api-reference/go/classes/migrate-ids.mdx @@ -4,7 +4,7 @@ sidebarTitle: MigrateIds description: CDKTN Core API Reference for MigrateIds in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IAspect diff --git a/content/api-reference/go/classes/named-cloud-workspace.mdx b/content/api-reference/go/classes/named-cloud-workspace.mdx index 7144420..dcf7e0e 100644 --- a/content/api-reference/go/classes/named-cloud-workspace.mdx +++ b/content/api-reference/go/classes/named-cloud-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: NamedCloudWorkspace description: CDKTN Core API Reference for NamedCloudWorkspace in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The name of a single Terraform Cloud workspace. diff --git a/content/api-reference/go/classes/named-remote-workspace.mdx b/content/api-reference/go/classes/named-remote-workspace.mdx index 93626d6..417cc0c 100644 --- a/content/api-reference/go/classes/named-remote-workspace.mdx +++ b/content/api-reference/go/classes/named-remote-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: NamedRemoteWorkspace description: CDKTN Core API Reference for NamedRemoteWorkspace in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IRemoteWorkspace diff --git a/content/api-reference/go/classes/number-list-list.mdx b/content/api-reference/go/classes/number-list-list.mdx index 2eac726..cc8fe4b 100644 --- a/content/api-reference/go/classes/number-list-list.mdx +++ b/content/api-reference/go/classes/number-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberListList description: CDKTN Core API Reference for NumberListList in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/number-list-map.mdx b/content/api-reference/go/classes/number-list-map.mdx index 107591a..2faa391 100644 --- a/content/api-reference/go/classes/number-list-map.mdx +++ b/content/api-reference/go/classes/number-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberListMap description: CDKTN Core API Reference for NumberListMap in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/number-map-list.mdx b/content/api-reference/go/classes/number-map-list.mdx index 2efcb49..80c56f4 100644 --- a/content/api-reference/go/classes/number-map-list.mdx +++ b/content/api-reference/go/classes/number-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberMapList description: CDKTN Core API Reference for NumberMapList in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/number-map.mdx b/content/api-reference/go/classes/number-map.mdx index 528d40e..f75635a 100644 --- a/content/api-reference/go/classes/number-map.mdx +++ b/content/api-reference/go/classes/number-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberMap description: CDKTN Core API Reference for NumberMap in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/go/classes/op.mdx b/content/api-reference/go/classes/op.mdx index 5fb7804..37989e1 100644 --- a/content/api-reference/go/classes/op.mdx +++ b/content/api-reference/go/classes/op.mdx @@ -4,7 +4,7 @@ sidebarTitle: Op description: CDKTN Core API Reference for Op in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} This class contains static functions for all arithmetical and logical operators in the Terraform configuration language. diff --git a/content/api-reference/go/classes/prefixed-remote-workspaces.mdx b/content/api-reference/go/classes/prefixed-remote-workspaces.mdx index a61a1b5..e4eea45 100644 --- a/content/api-reference/go/classes/prefixed-remote-workspaces.mdx +++ b/content/api-reference/go/classes/prefixed-remote-workspaces.mdx @@ -4,7 +4,7 @@ sidebarTitle: PrefixedRemoteWorkspaces description: CDKTN Core API Reference for PrefixedRemoteWorkspaces in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IRemoteWorkspace diff --git a/content/api-reference/go/classes/resource-terraform-iterator.mdx b/content/api-reference/go/classes/resource-terraform-iterator.mdx index a7bc381..521be9f 100644 --- a/content/api-reference/go/classes/resource-terraform-iterator.mdx +++ b/content/api-reference/go/classes/resource-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ResourceTerraformIterator description: CDKTN Core API Reference for ResourceTerraformIterator in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/string-concat.mdx b/content/api-reference/go/classes/string-concat.mdx index f3b50c7..defc080 100644 --- a/content/api-reference/go/classes/string-concat.mdx +++ b/content/api-reference/go/classes/string-concat.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringConcat description: CDKTN Core API Reference for StringConcat in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IFragmentConcatenator diff --git a/content/api-reference/go/classes/string-list-list.mdx b/content/api-reference/go/classes/string-list-list.mdx index 5d6390a..b85e1e4 100644 --- a/content/api-reference/go/classes/string-list-list.mdx +++ b/content/api-reference/go/classes/string-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringListList description: CDKTN Core API Reference for StringListList in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/string-list-map.mdx b/content/api-reference/go/classes/string-list-map.mdx index 5529802..3084bfa 100644 --- a/content/api-reference/go/classes/string-list-map.mdx +++ b/content/api-reference/go/classes/string-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringListMap description: CDKTN Core API Reference for StringListMap in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/string-map-list.mdx b/content/api-reference/go/classes/string-map-list.mdx index 322c6b1..23b6b69 100644 --- a/content/api-reference/go/classes/string-map-list.mdx +++ b/content/api-reference/go/classes/string-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMapList description: CDKTN Core API Reference for StringMapList in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/string-map-map.mdx b/content/api-reference/go/classes/string-map-map.mdx index 441146c..ebbd8e6 100644 --- a/content/api-reference/go/classes/string-map-map.mdx +++ b/content/api-reference/go/classes/string-map-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMapMap description: CDKTN Core API Reference for StringMapMap in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/go/classes/string-map.mdx b/content/api-reference/go/classes/string-map.mdx index 03ee98c..241ee4a 100644 --- a/content/api-reference/go/classes/string-map.mdx +++ b/content/api-reference/go/classes/string-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMap description: CDKTN Core API Reference for StringMap in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/go/classes/tagged-cloud-workspaces.mdx b/content/api-reference/go/classes/tagged-cloud-workspaces.mdx index 79a3c4e..f7fe4a9 100644 --- a/content/api-reference/go/classes/tagged-cloud-workspaces.mdx +++ b/content/api-reference/go/classes/tagged-cloud-workspaces.mdx @@ -4,7 +4,7 @@ sidebarTitle: TaggedCloudWorkspaces description: CDKTN Core API Reference for TaggedCloudWorkspaces in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} A set of Terraform Cloud workspace tags. diff --git a/content/api-reference/go/classes/terraform-count.mdx b/content/api-reference/go/classes/terraform-count.mdx index 535121c..008be14 100644 --- a/content/api-reference/go/classes/terraform-count.mdx +++ b/content/api-reference/go/classes/terraform-count.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformCount description: CDKTN Core API Reference for TerraformCount in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Iterator for the Terraform count property. diff --git a/content/api-reference/go/classes/terraform-iterator.mdx b/content/api-reference/go/classes/terraform-iterator.mdx index 243c4d0..961758b 100644 --- a/content/api-reference/go/classes/terraform-iterator.mdx +++ b/content/api-reference/go/classes/terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformIterator description: CDKTN Core API Reference for TerraformIterator in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformIterator diff --git a/content/api-reference/go/classes/terraform-resource-targets.mdx b/content/api-reference/go/classes/terraform-resource-targets.mdx index bfd3f29..9bc198c 100644 --- a/content/api-reference/go/classes/terraform-resource-targets.mdx +++ b/content/api-reference/go/classes/terraform-resource-targets.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceTargets description: CDKTN Core API Reference for TerraformResourceTargets in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/classes/terraform-self.mdx b/content/api-reference/go/classes/terraform-self.mdx index 3150ce8..19b3c18 100644 --- a/content/api-reference/go/classes/terraform-self.mdx +++ b/content/api-reference/go/classes/terraform-self.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformSelf description: CDKTN Core API Reference for TerraformSelf in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Expressions in connection blocks cannot refer to their parent resource by name. diff --git a/content/api-reference/go/classes/testing.mdx b/content/api-reference/go/classes/testing.mdx index dfc2df7..628206e 100644 --- a/content/api-reference/go/classes/testing.mdx +++ b/content/api-reference/go/classes/testing.mdx @@ -4,7 +4,7 @@ sidebarTitle: Testing description: CDKTN Core API Reference for Testing in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Testing utilities for cdktf applications. diff --git a/content/api-reference/go/classes/token.mdx b/content/api-reference/go/classes/token.mdx index 35af40a..29e2947 100644 --- a/content/api-reference/go/classes/token.mdx +++ b/content/api-reference/go/classes/token.mdx @@ -4,7 +4,7 @@ sidebarTitle: Token description: CDKTN Core API Reference for Token in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Represents a special or lazily-evaluated value. diff --git a/content/api-reference/go/classes/tokenization.mdx b/content/api-reference/go/classes/tokenization.mdx index 2d02449..bb0be72 100644 --- a/content/api-reference/go/classes/tokenization.mdx +++ b/content/api-reference/go/classes/tokenization.mdx @@ -4,7 +4,7 @@ sidebarTitle: Tokenization description: CDKTN Core API Reference for Tokenization in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Less oft-needed functions to manipulate Tokens. diff --git a/content/api-reference/go/classes/tokenized-string-fragments.mdx b/content/api-reference/go/classes/tokenized-string-fragments.mdx index f0633a7..ea67e1a 100644 --- a/content/api-reference/go/classes/tokenized-string-fragments.mdx +++ b/content/api-reference/go/classes/tokenized-string-fragments.mdx @@ -4,7 +4,7 @@ sidebarTitle: TokenizedStringFragments description: CDKTN Core API Reference for TokenizedStringFragments in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Fragments of a concatenated string containing stringified Tokens. diff --git a/content/api-reference/go/classes/variable-type.mdx b/content/api-reference/go/classes/variable-type.mdx index 4940cdf..75d0121 100644 --- a/content/api-reference/go/classes/variable-type.mdx +++ b/content/api-reference/go/classes/variable-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: VariableType description: CDKTN Core API Reference for VariableType in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/go/constructs/app.mdx b/content/api-reference/go/constructs/app.mdx index de48399..4046782 100644 --- a/content/api-reference/go/constructs/app.mdx +++ b/content/api-reference/go/constructs/app.mdx @@ -4,7 +4,7 @@ sidebarTitle: App description: CDKTN Core API Reference for App in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Represents a cdktn application. @@ -35,6 +35,7 @@ configuration. | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | CrossStackReference | Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources. | | Synth | Synthesizes all resources to the output directory. | @@ -48,6 +49,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `CrossStackReference` ```go diff --git a/content/api-reference/go/constructs/azurerm-backend.mdx b/content/api-reference/go/constructs/azurerm-backend.mdx index fec6ef9..c48e970 100644 --- a/content/api-reference/go/constructs/azurerm-backend.mdx +++ b/content/api-reference/go/constructs/azurerm-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: AzurermBackend description: CDKTN Core API Reference for AzurermBackend in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ cdktn.NewAzurermBackend(scope Construct, props AzurermBackendConfig) AzurermBack | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/cloud-backend.mdx b/content/api-reference/go/constructs/cloud-backend.mdx index a2154be..c995526 100644 --- a/content/api-reference/go/constructs/cloud-backend.mdx +++ b/content/api-reference/go/constructs/cloud-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudBackend description: CDKTN Core API Reference for CloudBackend in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The Cloud Backend synthesizes a [cloud block](https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block). The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings. @@ -40,6 +40,7 @@ cdktn.NewCloudBackend(scope Construct, props CloudBackendConfig) CloudBackend | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -58,6 +59,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/consul-backend.mdx b/content/api-reference/go/constructs/consul-backend.mdx index 0a13876..666f2bc 100644 --- a/content/api-reference/go/constructs/consul-backend.mdx +++ b/content/api-reference/go/constructs/consul-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: ConsulBackend description: CDKTN Core API Reference for ConsulBackend in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ cdktn.NewConsulBackend(scope Construct, props ConsulBackendConfig) ConsulBackend | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/cos-backend.mdx b/content/api-reference/go/constructs/cos-backend.mdx index 3df4dbb..027c682 100644 --- a/content/api-reference/go/constructs/cos-backend.mdx +++ b/content/api-reference/go/constructs/cos-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackend description: CDKTN Core API Reference for CosBackend in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ cdktn.NewCosBackend(scope Construct, props CosBackendConfig) CosBackend | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/data-resource.mdx b/content/api-reference/go/constructs/data-resource.mdx index a6e2786..26afad5 100644 --- a/content/api-reference/go/constructs/data-resource.mdx +++ b/content/api-reference/go/constructs/data-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataResource description: CDKTN Core API Reference for DataResource in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The DataResource implements the standard resource lifecycle, but does not directly take any other actions. @@ -63,6 +63,7 @@ Must be unique amongst siblings in the same scope | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -98,6 +99,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/data-terraform-remote-state-azurerm.mdx b/content/api-reference/go/constructs/data-terraform-remote-state-azurerm.mdx index 85df40c..dd69ac9 100644 --- a/content/api-reference/go/constructs/data-terraform-remote-state-azurerm.mdx +++ b/content/api-reference/go/constructs/data-terraform-remote-state-azurerm.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateAzurerm description: CDKTN Core API Reference for DataTerraformRemoteStateAzurerm in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewDataTerraformRemoteStateAzurerm(scope Construct, id *string, config Dat | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/data-terraform-remote-state-consul.mdx b/content/api-reference/go/constructs/data-terraform-remote-state-consul.mdx index eaadbe5..70e4596 100644 --- a/content/api-reference/go/constructs/data-terraform-remote-state-consul.mdx +++ b/content/api-reference/go/constructs/data-terraform-remote-state-consul.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConsul description: CDKTN Core API Reference for DataTerraformRemoteStateConsul in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewDataTerraformRemoteStateConsul(scope Construct, id *string, config Data | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/data-terraform-remote-state-cos.mdx b/content/api-reference/go/constructs/data-terraform-remote-state-cos.mdx index 39df299..cbd3937 100644 --- a/content/api-reference/go/constructs/data-terraform-remote-state-cos.mdx +++ b/content/api-reference/go/constructs/data-terraform-remote-state-cos.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateCos description: CDKTN Core API Reference for DataTerraformRemoteStateCos in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewDataTerraformRemoteStateCos(scope Construct, id *string, config DataTer | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/data-terraform-remote-state-gcs.mdx b/content/api-reference/go/constructs/data-terraform-remote-state-gcs.mdx index 7c69d71..dddd857 100644 --- a/content/api-reference/go/constructs/data-terraform-remote-state-gcs.mdx +++ b/content/api-reference/go/constructs/data-terraform-remote-state-gcs.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateGcs description: CDKTN Core API Reference for DataTerraformRemoteStateGcs in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewDataTerraformRemoteStateGcs(scope Construct, id *string, config DataTer | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/data-terraform-remote-state-http.mdx b/content/api-reference/go/constructs/data-terraform-remote-state-http.mdx index 6513afc..088acc5 100644 --- a/content/api-reference/go/constructs/data-terraform-remote-state-http.mdx +++ b/content/api-reference/go/constructs/data-terraform-remote-state-http.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateHttp description: CDKTN Core API Reference for DataTerraformRemoteStateHttp in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewDataTerraformRemoteStateHttp(scope Construct, id *string, config DataTe | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/data-terraform-remote-state-local.mdx b/content/api-reference/go/constructs/data-terraform-remote-state-local.mdx index de61558..4a5ec40 100644 --- a/content/api-reference/go/constructs/data-terraform-remote-state-local.mdx +++ b/content/api-reference/go/constructs/data-terraform-remote-state-local.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateLocal description: CDKTN Core API Reference for DataTerraformRemoteStateLocal in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewDataTerraformRemoteStateLocal(scope Construct, id *string, config DataT | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/data-terraform-remote-state-oss.mdx b/content/api-reference/go/constructs/data-terraform-remote-state-oss.mdx index 1d215f9..f98c7e8 100644 --- a/content/api-reference/go/constructs/data-terraform-remote-state-oss.mdx +++ b/content/api-reference/go/constructs/data-terraform-remote-state-oss.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateOss description: CDKTN Core API Reference for DataTerraformRemoteStateOss in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewDataTerraformRemoteStateOss(scope Construct, id *string, config DataTer | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/data-terraform-remote-state-pg.mdx b/content/api-reference/go/constructs/data-terraform-remote-state-pg.mdx index 3c9feb5..3abdce6 100644 --- a/content/api-reference/go/constructs/data-terraform-remote-state-pg.mdx +++ b/content/api-reference/go/constructs/data-terraform-remote-state-pg.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStatePg description: CDKTN Core API Reference for DataTerraformRemoteStatePg in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewDataTerraformRemoteStatePg(scope Construct, id *string, config DataTerr | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/data-terraform-remote-state-s3.mdx b/content/api-reference/go/constructs/data-terraform-remote-state-s3.mdx index 07539b4..86e3f69 100644 --- a/content/api-reference/go/constructs/data-terraform-remote-state-s3.mdx +++ b/content/api-reference/go/constructs/data-terraform-remote-state-s3.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateS3 description: CDKTN Core API Reference for DataTerraformRemoteStateS3 in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewDataTerraformRemoteStateS3(scope Construct, id *string, config DataTerr | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/data-terraform-remote-state-swift.mdx b/content/api-reference/go/constructs/data-terraform-remote-state-swift.mdx index 1275048..15701b5 100644 --- a/content/api-reference/go/constructs/data-terraform-remote-state-swift.mdx +++ b/content/api-reference/go/constructs/data-terraform-remote-state-swift.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateSwift description: CDKTN Core API Reference for DataTerraformRemoteStateSwift in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewDataTerraformRemoteStateSwift(scope Construct, id *string, config DataT | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ func ToString() *string Returns a string representation of this construct. +### ~~`With`~~ + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### ~~`AddOverride`~~ ```go diff --git a/content/api-reference/go/constructs/data-terraform-remote-state.mdx b/content/api-reference/go/constructs/data-terraform-remote-state.mdx index 7377985..0578347 100644 --- a/content/api-reference/go/constructs/data-terraform-remote-state.mdx +++ b/content/api-reference/go/constructs/data-terraform-remote-state.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteState description: CDKTN Core API Reference for DataTerraformRemoteState in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewDataTerraformRemoteState(scope Construct, id *string, config DataTerraf | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/gcs-backend.mdx b/content/api-reference/go/constructs/gcs-backend.mdx index f64a33d..bac5e22 100644 --- a/content/api-reference/go/constructs/gcs-backend.mdx +++ b/content/api-reference/go/constructs/gcs-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: GcsBackend description: CDKTN Core API Reference for GcsBackend in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ cdktn.NewGcsBackend(scope Construct, props GcsBackendConfig) GcsBackend | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/http-backend.mdx b/content/api-reference/go/constructs/http-backend.mdx index 4cb0234..e09405e 100644 --- a/content/api-reference/go/constructs/http-backend.mdx +++ b/content/api-reference/go/constructs/http-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: HttpBackend description: CDKTN Core API Reference for HttpBackend in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ cdktn.NewHttpBackend(scope Construct, props HttpBackendConfig) HttpBackend | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/importable-resource.mdx b/content/api-reference/go/constructs/importable-resource.mdx index 80c22a2..0c137c6 100644 --- a/content/api-reference/go/constructs/importable-resource.mdx +++ b/content/api-reference/go/constructs/importable-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: ImportableResource description: CDKTN Core API Reference for ImportableResource in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Class used to represent an importable resource. @@ -47,6 +47,7 @@ cdktn.NewImportableResource(scope Construct, name *string, config IImportableCon | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -64,6 +65,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/local-backend.mdx b/content/api-reference/go/constructs/local-backend.mdx index 7364e6e..6d1ef0d 100644 --- a/content/api-reference/go/constructs/local-backend.mdx +++ b/content/api-reference/go/constructs/local-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalBackend description: CDKTN Core API Reference for LocalBackend in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ cdktn.NewLocalBackend(scope Construct, props LocalBackendConfig) LocalBackend | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/oss-backend.mdx b/content/api-reference/go/constructs/oss-backend.mdx index 52ce1c9..324a246 100644 --- a/content/api-reference/go/constructs/oss-backend.mdx +++ b/content/api-reference/go/constructs/oss-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssBackend description: CDKTN Core API Reference for OssBackend in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ cdktn.NewOssBackend(scope Construct, props OssBackendConfig) OssBackend | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/pg-backend.mdx b/content/api-reference/go/constructs/pg-backend.mdx index 1d0fbe4..847ce48 100644 --- a/content/api-reference/go/constructs/pg-backend.mdx +++ b/content/api-reference/go/constructs/pg-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: PgBackend description: CDKTN Core API Reference for PgBackend in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ cdktn.NewPgBackend(scope Construct, props PgBackendConfig) PgBackend | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/remote-backend.mdx b/content/api-reference/go/constructs/remote-backend.mdx index e822284..1219cf3 100644 --- a/content/api-reference/go/constructs/remote-backend.mdx +++ b/content/api-reference/go/constructs/remote-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteBackend description: CDKTN Core API Reference for RemoteBackend in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ cdktn.NewRemoteBackend(scope Construct, props RemoteBackendConfig) RemoteBackend | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/resource.mdx b/content/api-reference/go/constructs/resource.mdx index 3999dbc..3b2f9aa 100644 --- a/content/api-reference/go/constructs/resource.mdx +++ b/content/api-reference/go/constructs/resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: Resource description: CDKTN Core API Reference for Resource in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IResource @@ -42,6 +42,7 @@ cdktn.NewResource(scope Construct, id *string) Resource | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | *** @@ -53,6 +54,27 @@ func ToString() *string Returns a string representation of this construct. +### ~~`With`~~ + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ## Static Functions | **Name** | **Description** | diff --git a/content/api-reference/go/constructs/s3-backend.mdx b/content/api-reference/go/constructs/s3-backend.mdx index 52c14df..0707dfc 100644 --- a/content/api-reference/go/constructs/s3-backend.mdx +++ b/content/api-reference/go/constructs/s3-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3Backend description: CDKTN Core API Reference for S3Backend in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ cdktn.NewS3Backend(scope Construct, props S3BackendConfig) S3Backend | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/swift-backend.mdx b/content/api-reference/go/constructs/swift-backend.mdx index 66b1cf4..3659c25 100644 --- a/content/api-reference/go/constructs/swift-backend.mdx +++ b/content/api-reference/go/constructs/swift-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: SwiftBackend description: CDKTN Core API Reference for SwiftBackend in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ cdktn.NewSwiftBackend(scope Construct, props SwiftBackendConfig) SwiftBackend | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ func ToString() *string Returns a string representation of this construct. +### ~~`With`~~ + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### ~~`AddOverride`~~ ```go diff --git a/content/api-reference/go/constructs/terraform-asset.mdx b/content/api-reference/go/constructs/terraform-asset.mdx index e6020db..539d10c 100644 --- a/content/api-reference/go/constructs/terraform-asset.mdx +++ b/content/api-reference/go/constructs/terraform-asset.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformAsset description: CDKTN Core API Reference for TerraformAsset in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewTerraformAsset(scope Construct, id *string, config TerraformAssetConfig | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | *** @@ -56,6 +57,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ## Static Functions | **Name** | **Description** | diff --git a/content/api-reference/go/constructs/terraform-backend.mdx b/content/api-reference/go/constructs/terraform-backend.mdx index fadfa42..78266d8 100644 --- a/content/api-reference/go/constructs/terraform-backend.mdx +++ b/content/api-reference/go/constructs/terraform-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformBackend description: CDKTN Core API Reference for TerraformBackend in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewTerraformBackend(scope Construct, id *string, name *string) TerraformBa | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -63,6 +64,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/terraform-data-source.mdx b/content/api-reference/go/constructs/terraform-data-source.mdx index 627fc53..c4fcaf8 100644 --- a/content/api-reference/go/constructs/terraform-data-source.mdx +++ b/content/api-reference/go/constructs/terraform-data-source.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformDataSource description: CDKTN Core API Reference for TerraformDataSource in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformResource, ITerraformDependable, IInterpolatingParent @@ -47,6 +47,7 @@ cdktn.NewTerraformDataSource(scope Construct, id *string, config TerraformResour | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -74,6 +75,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/terraform-element.mdx b/content/api-reference/go/constructs/terraform-element.mdx index 353a380..eb932d7 100644 --- a/content/api-reference/go/constructs/terraform-element.mdx +++ b/content/api-reference/go/constructs/terraform-element.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformElement description: CDKTN Core API Reference for TerraformElement in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewTerraformElement(scope Construct, id *string, elementType *string) Terr | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -62,6 +63,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/terraform-hcl-module.mdx b/content/api-reference/go/constructs/terraform-hcl-module.mdx index 0814f11..4ac815e 100644 --- a/content/api-reference/go/constructs/terraform-hcl-module.mdx +++ b/content/api-reference/go/constructs/terraform-hcl-module.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformHclModule description: CDKTN Core API Reference for TerraformHclModule in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewTerraformHclModule(scope Construct, id *string, options TerraformHclMod | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -70,6 +71,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/terraform-local.mdx b/content/api-reference/go/constructs/terraform-local.mdx index 1c9cae2..ae30d8e 100644 --- a/content/api-reference/go/constructs/terraform-local.mdx +++ b/content/api-reference/go/constructs/terraform-local.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformLocal description: CDKTN Core API Reference for TerraformLocal in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -47,6 +47,7 @@ cdktn.NewTerraformLocal(scope Construct, id *string, expression interface{}) Ter | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -64,6 +65,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/terraform-module.mdx b/content/api-reference/go/constructs/terraform-module.mdx index a396ba7..b85cab7 100644 --- a/content/api-reference/go/constructs/terraform-module.mdx +++ b/content/api-reference/go/constructs/terraform-module.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModule description: CDKTN Core API Reference for TerraformModule in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformDependable @@ -56,6 +56,7 @@ cdktn.NewTerraformModule(scope Construct, id *string, options TerraformModuleCon | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -76,6 +77,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/terraform-output.mdx b/content/api-reference/go/constructs/terraform-output.mdx index 79632c2..05ccd37 100644 --- a/content/api-reference/go/constructs/terraform-output.mdx +++ b/content/api-reference/go/constructs/terraform-output.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformOutput description: CDKTN Core API Reference for TerraformOutput in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewTerraformOutput(scope Construct, id *string, config TerraformOutputConf | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -62,6 +63,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/terraform-provider.mdx b/content/api-reference/go/constructs/terraform-provider.mdx index 7e791e5..675401e 100644 --- a/content/api-reference/go/constructs/terraform-provider.mdx +++ b/content/api-reference/go/constructs/terraform-provider.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProvider description: CDKTN Core API Reference for TerraformProvider in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ cdktn.NewTerraformProvider(scope Construct, id *string, config TerraformProvider | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -62,6 +63,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/terraform-remote-state.mdx b/content/api-reference/go/constructs/terraform-remote-state.mdx index c663aca..ae37d15 100644 --- a/content/api-reference/go/constructs/terraform-remote-state.mdx +++ b/content/api-reference/go/constructs/terraform-remote-state.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformRemoteState description: CDKTN Core API Reference for TerraformRemoteState in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -54,6 +54,7 @@ cdktn.NewTerraformRemoteState(scope Construct, id *string, backend *string, conf | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -76,6 +77,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/terraform-resource.mdx b/content/api-reference/go/constructs/terraform-resource.mdx index c7057be..8eb8ddb 100644 --- a/content/api-reference/go/constructs/terraform-resource.mdx +++ b/content/api-reference/go/constructs/terraform-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResource description: CDKTN Core API Reference for TerraformResource in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformResource, ITerraformDependable, IInterpolatingParent @@ -47,6 +47,7 @@ cdktn.NewTerraformResource(scope Construct, id *string, config TerraformResource | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -80,6 +81,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/constructs/terraform-stack.mdx b/content/api-reference/go/constructs/terraform-stack.mdx index f34be20..bebd658 100644 --- a/content/api-reference/go/constructs/terraform-stack.mdx +++ b/content/api-reference/go/constructs/terraform-stack.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformStack description: CDKTN Core API Reference for TerraformStack in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ cdktn.NewTerraformStack(scope Construct, id *string) TerraformStack | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddDependency | *No description.* | | AddOverride | *No description.* | | AllProviders | *No description.* | @@ -62,6 +63,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddDependency` ```go diff --git a/content/api-reference/go/constructs/terraform-variable.mdx b/content/api-reference/go/constructs/terraform-variable.mdx index 3bc58b2..3432807 100644 --- a/content/api-reference/go/constructs/terraform-variable.mdx +++ b/content/api-reference/go/constructs/terraform-variable.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariable description: CDKTN Core API Reference for TerraformVariable in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -47,6 +47,7 @@ cdktn.NewTerraformVariable(scope Construct, id *string, config TerraformVariable | **Name** | **Description** | | --- | --- | | ToString | Returns a string representation of this construct. | +| With | Applies one or more mixins to this construct. | | AddOverride | *No description.* | | OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ func ToString() *string Returns a string representation of this construct. +### `With` + +```go +func With(mixins ...IMixin) IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...github.com/aws/constructs-go/constructs/v10.IMixin + +The mixins to apply. + +*** + ### `AddOverride` ```go diff --git a/content/api-reference/go/enums/annotation-metadata-entry-type.mdx b/content/api-reference/go/enums/annotation-metadata-entry-type.mdx index 1ef802d..045bcf4 100644 --- a/content/api-reference/go/enums/annotation-metadata-entry-type.mdx +++ b/content/api-reference/go/enums/annotation-metadata-entry-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnnotationMetadataEntryType description: CDKTN Core API Reference for AnnotationMetadataEntryType in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Members diff --git a/content/api-reference/go/enums/asset-type.mdx b/content/api-reference/go/enums/asset-type.mdx index 837a864..06989c3 100644 --- a/content/api-reference/go/enums/asset-type.mdx +++ b/content/api-reference/go/enums/asset-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: AssetType description: CDKTN Core API Reference for AssetType in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Members diff --git a/content/api-reference/go/protocols/i-any-producer.mdx b/content/api-reference/go/protocols/i-any-producer.mdx index c6f76a4..70b95ee 100644 --- a/content/api-reference/go/protocols/i-any-producer.mdx +++ b/content/api-reference/go/protocols/i-any-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IAnyProducer description: CDKTN Core API Reference for IAnyProducer in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IAnyProducer diff --git a/content/api-reference/go/protocols/i-aspect.mdx b/content/api-reference/go/protocols/i-aspect.mdx index 9bdfeed..1466ff8 100644 --- a/content/api-reference/go/protocols/i-aspect.mdx +++ b/content/api-reference/go/protocols/i-aspect.mdx @@ -4,7 +4,7 @@ sidebarTitle: IAspect description: CDKTN Core API Reference for IAspect in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* MigrateIds, IAspect diff --git a/content/api-reference/go/protocols/i-fragment-concatenator.mdx b/content/api-reference/go/protocols/i-fragment-concatenator.mdx index dea24fb..27fa69c 100644 --- a/content/api-reference/go/protocols/i-fragment-concatenator.mdx +++ b/content/api-reference/go/protocols/i-fragment-concatenator.mdx @@ -4,7 +4,7 @@ sidebarTitle: IFragmentConcatenator description: CDKTN Core API Reference for IFragmentConcatenator in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* StringConcat, IFragmentConcatenator diff --git a/content/api-reference/go/protocols/i-importable-config.mdx b/content/api-reference/go/protocols/i-importable-config.mdx index e0abe27..346219d 100644 --- a/content/api-reference/go/protocols/i-importable-config.mdx +++ b/content/api-reference/go/protocols/i-importable-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: IImportableConfig description: CDKTN Core API Reference for IImportableConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IImportableConfig diff --git a/content/api-reference/go/protocols/i-interpolating-parent.mdx b/content/api-reference/go/protocols/i-interpolating-parent.mdx index ad1f5bf..74fff0e 100644 --- a/content/api-reference/go/protocols/i-interpolating-parent.mdx +++ b/content/api-reference/go/protocols/i-interpolating-parent.mdx @@ -4,7 +4,7 @@ sidebarTitle: IInterpolatingParent description: CDKTN Core API Reference for IInterpolatingParent in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyMapList, BooleanMapList, ComplexComputedList, ComplexObject, DataResource, MapList, NumberMapList, StringMapList, TerraformDataSource, TerraformResource, IInterpolatingParent diff --git a/content/api-reference/go/protocols/i-list-producer.mdx b/content/api-reference/go/protocols/i-list-producer.mdx index 71f9507..dc7bf52 100644 --- a/content/api-reference/go/protocols/i-list-producer.mdx +++ b/content/api-reference/go/protocols/i-list-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IListProducer description: CDKTN Core API Reference for IListProducer in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IListProducer diff --git a/content/api-reference/go/protocols/i-manifest.mdx b/content/api-reference/go/protocols/i-manifest.mdx index a4232de..7fe4c86 100644 --- a/content/api-reference/go/protocols/i-manifest.mdx +++ b/content/api-reference/go/protocols/i-manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: IManifest description: CDKTN Core API Reference for IManifest in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* Manifest, IManifest diff --git a/content/api-reference/go/protocols/i-number-producer.mdx b/content/api-reference/go/protocols/i-number-producer.mdx index fa3d664..7ff7334 100644 --- a/content/api-reference/go/protocols/i-number-producer.mdx +++ b/content/api-reference/go/protocols/i-number-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: INumberProducer description: CDKTN Core API Reference for INumberProducer in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* INumberProducer diff --git a/content/api-reference/go/protocols/i-post-processor.mdx b/content/api-reference/go/protocols/i-post-processor.mdx index 04f5209..7834927 100644 --- a/content/api-reference/go/protocols/i-post-processor.mdx +++ b/content/api-reference/go/protocols/i-post-processor.mdx @@ -4,7 +4,7 @@ sidebarTitle: IPostProcessor description: CDKTN Core API Reference for IPostProcessor in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IPostProcessor diff --git a/content/api-reference/go/protocols/i-remote-workspace.mdx b/content/api-reference/go/protocols/i-remote-workspace.mdx index 81a63a2..e10d55c 100644 --- a/content/api-reference/go/protocols/i-remote-workspace.mdx +++ b/content/api-reference/go/protocols/i-remote-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: IRemoteWorkspace description: CDKTN Core API Reference for IRemoteWorkspace in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* NamedRemoteWorkspace, PrefixedRemoteWorkspaces, IRemoteWorkspace diff --git a/content/api-reference/go/protocols/i-resolvable.mdx b/content/api-reference/go/protocols/i-resolvable.mdx index 3f0ac99..668f4c3 100644 --- a/content/api-reference/go/protocols/i-resolvable.mdx +++ b/content/api-reference/go/protocols/i-resolvable.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResolvable description: CDKTN Core API Reference for IResolvable in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyListList, AnyListMap, AnyMap, AnyMapList, BooleanList, BooleanListList, BooleanListMap, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, LazyBase, MapList, NumberListList, NumberListMap, NumberMap, NumberMapList, StringListList, StringListMap, StringMap, StringMapList, StringMapMap, IResolvable diff --git a/content/api-reference/go/protocols/i-resolve-context.mdx b/content/api-reference/go/protocols/i-resolve-context.mdx index 3e0184a..db5215a 100644 --- a/content/api-reference/go/protocols/i-resolve-context.mdx +++ b/content/api-reference/go/protocols/i-resolve-context.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResolveContext description: CDKTN Core API Reference for IResolveContext in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IResolveContext diff --git a/content/api-reference/go/protocols/i-resource-constructor.mdx b/content/api-reference/go/protocols/i-resource-constructor.mdx index 5da81c2..e2dd835 100644 --- a/content/api-reference/go/protocols/i-resource-constructor.mdx +++ b/content/api-reference/go/protocols/i-resource-constructor.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResourceConstructor description: CDKTN Core API Reference for IResourceConstructor in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IResourceConstructor diff --git a/content/api-reference/go/protocols/i-resource.mdx b/content/api-reference/go/protocols/i-resource.mdx index 865bbe8..79dd89c 100644 --- a/content/api-reference/go/protocols/i-resource.mdx +++ b/content/api-reference/go/protocols/i-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResource description: CDKTN Core API Reference for IResource in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Extends:* github.com/aws/constructs-go/constructs/v10.IConstruct diff --git a/content/api-reference/go/protocols/i-scope-callback.mdx b/content/api-reference/go/protocols/i-scope-callback.mdx index 38d1e3c..fb6b452 100644 --- a/content/api-reference/go/protocols/i-scope-callback.mdx +++ b/content/api-reference/go/protocols/i-scope-callback.mdx @@ -4,7 +4,7 @@ sidebarTitle: IScopeCallback description: CDKTN Core API Reference for IScopeCallback in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IScopeCallback diff --git a/content/api-reference/go/protocols/i-stack-synthesizer.mdx b/content/api-reference/go/protocols/i-stack-synthesizer.mdx index 99f82a1..8ef1106 100644 --- a/content/api-reference/go/protocols/i-stack-synthesizer.mdx +++ b/content/api-reference/go/protocols/i-stack-synthesizer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IStackSynthesizer description: CDKTN Core API Reference for IStackSynthesizer in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IStackSynthesizer diff --git a/content/api-reference/go/protocols/i-string-producer.mdx b/content/api-reference/go/protocols/i-string-producer.mdx index a906592..9be24a4 100644 --- a/content/api-reference/go/protocols/i-string-producer.mdx +++ b/content/api-reference/go/protocols/i-string-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IStringProducer description: CDKTN Core API Reference for IStringProducer in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IStringProducer diff --git a/content/api-reference/go/protocols/i-synthesis-session.mdx b/content/api-reference/go/protocols/i-synthesis-session.mdx index 8581bee..edaaccd 100644 --- a/content/api-reference/go/protocols/i-synthesis-session.mdx +++ b/content/api-reference/go/protocols/i-synthesis-session.mdx @@ -4,7 +4,7 @@ sidebarTitle: ISynthesisSession description: CDKTN Core API Reference for ISynthesisSession in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* ISynthesisSession diff --git a/content/api-reference/go/protocols/i-terraform-addressable.mdx b/content/api-reference/go/protocols/i-terraform-addressable.mdx index 2ff2596..9faeaae 100644 --- a/content/api-reference/go/protocols/i-terraform-addressable.mdx +++ b/content/api-reference/go/protocols/i-terraform-addressable.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformAddressable description: CDKTN Core API Reference for ITerraformAddressable in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyListList, AnyListMap, AnyMap, AnyMapList, BooleanList, BooleanListList, BooleanListMap, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, DataResource, DataTerraformRemoteState, DataTerraformRemoteStateAzurerm, DataTerraformRemoteStateConsul, DataTerraformRemoteStateCos, DataTerraformRemoteStateGcs, DataTerraformRemoteStateHttp, DataTerraformRemoteStateLocal, DataTerraformRemoteStateOss, DataTerraformRemoteStatePg, DataTerraformRemoteStateS3, DataTerraformRemoteStateSwift, MapList, NumberListList, NumberListMap, NumberMap, NumberMapList, StringListList, StringListMap, StringMap, StringMapList, StringMapMap, TerraformDataSource, TerraformHclModule, TerraformLocal, TerraformModule, TerraformRemoteState, TerraformResource, TerraformVariable, ITerraformAddressable, ITerraformDependable diff --git a/content/api-reference/go/protocols/i-terraform-dependable.mdx b/content/api-reference/go/protocols/i-terraform-dependable.mdx index 47b3a84..df08712 100644 --- a/content/api-reference/go/protocols/i-terraform-dependable.mdx +++ b/content/api-reference/go/protocols/i-terraform-dependable.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformDependable description: CDKTN Core API Reference for ITerraformDependable in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Extends:* ITerraformAddressable diff --git a/content/api-reference/go/protocols/i-terraform-iterator.mdx b/content/api-reference/go/protocols/i-terraform-iterator.mdx index 36fe510..63f76ed 100644 --- a/content/api-reference/go/protocols/i-terraform-iterator.mdx +++ b/content/api-reference/go/protocols/i-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformIterator description: CDKTN Core API Reference for ITerraformIterator in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DynamicListTerraformIterator, ListTerraformIterator, MapTerraformIterator, ResourceTerraformIterator, TerraformIterator, ITerraformIterator diff --git a/content/api-reference/go/protocols/i-terraform-resource.mdx b/content/api-reference/go/protocols/i-terraform-resource.mdx index c3b1348..a7a5ef1 100644 --- a/content/api-reference/go/protocols/i-terraform-resource.mdx +++ b/content/api-reference/go/protocols/i-terraform-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformResource description: CDKTN Core API Reference for ITerraformResource in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DataResource, TerraformDataSource, TerraformResource, ITerraformResource diff --git a/content/api-reference/go/protocols/i-token-mapper.mdx b/content/api-reference/go/protocols/i-token-mapper.mdx index ddc8e44..9324bf0 100644 --- a/content/api-reference/go/protocols/i-token-mapper.mdx +++ b/content/api-reference/go/protocols/i-token-mapper.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITokenMapper description: CDKTN Core API Reference for ITokenMapper in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* ITokenMapper diff --git a/content/api-reference/go/protocols/i-token-resolver.mdx b/content/api-reference/go/protocols/i-token-resolver.mdx index 2f0b113..ae47f9d 100644 --- a/content/api-reference/go/protocols/i-token-resolver.mdx +++ b/content/api-reference/go/protocols/i-token-resolver.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITokenResolver description: CDKTN Core API Reference for ITokenResolver in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DefaultTokenResolver, ITokenResolver diff --git a/content/api-reference/go/structs/app-config.mdx b/content/api-reference/go/structs/app-config.mdx index 0fe501b..1d88613 100644 --- a/content/api-reference/go/structs/app-config.mdx +++ b/content/api-reference/go/structs/app-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: AppConfig description: CDKTN Core API Reference for AppConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/azurerm-backend-config.mdx b/content/api-reference/go/structs/azurerm-backend-config.mdx index 7261f82..5f12052 100644 --- a/content/api-reference/go/structs/azurerm-backend-config.mdx +++ b/content/api-reference/go/structs/azurerm-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: AzurermBackendConfig description: CDKTN Core API Reference for AzurermBackendConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as a Blob with the given Key within the Blob Container within the Blob Storage Account. diff --git a/content/api-reference/go/structs/cloud-backend-config.mdx b/content/api-reference/go/structs/cloud-backend-config.mdx index ff4d332..58d4e75 100644 --- a/content/api-reference/go/structs/cloud-backend-config.mdx +++ b/content/api-reference/go/structs/cloud-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudBackendConfig description: CDKTN Core API Reference for CloudBackendConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The Cloud Backend synthesizes a [cloud block](https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block). The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings. diff --git a/content/api-reference/go/structs/consul-backend-config.mdx b/content/api-reference/go/structs/consul-backend-config.mdx index 5bac5b1..4fc8b2c 100644 --- a/content/api-reference/go/structs/consul-backend-config.mdx +++ b/content/api-reference/go/structs/consul-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: ConsulBackendConfig description: CDKTN Core API Reference for ConsulBackendConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state in the Consul KV store at a given path. This backend supports state locking. diff --git a/content/api-reference/go/structs/cos-backend-assume-role.mdx b/content/api-reference/go/structs/cos-backend-assume-role.mdx index dc45bbe..63ad171 100644 --- a/content/api-reference/go/structs/cos-backend-assume-role.mdx +++ b/content/api-reference/go/structs/cos-backend-assume-role.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackendAssumeRole description: CDKTN Core API Reference for CosBackendAssumeRole in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/cos-backend-config.mdx b/content/api-reference/go/structs/cos-backend-config.mdx index 4a20a3c..40001c3 100644 --- a/content/api-reference/go/structs/cos-backend-config.mdx +++ b/content/api-reference/go/structs/cos-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackendConfig description: CDKTN Core API Reference for CosBackendConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as an object in a configurable prefix in a given bucket on Tencent Cloud Object Storage (COS). diff --git a/content/api-reference/go/structs/data-config.mdx b/content/api-reference/go/structs/data-config.mdx index 42df21f..9105a74 100644 --- a/content/api-reference/go/structs/data-config.mdx +++ b/content/api-reference/go/structs/data-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataConfig description: CDKTN Core API Reference for DataConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/data-terraform-remote-state-azurerm-config.mdx b/content/api-reference/go/structs/data-terraform-remote-state-azurerm-config.mdx index cca2ffd..9c3eb6a 100644 --- a/content/api-reference/go/structs/data-terraform-remote-state-azurerm-config.mdx +++ b/content/api-reference/go/structs/data-terraform-remote-state-azurerm-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateAzurermConfig description: CDKTN Core API Reference for DataTerraformRemoteStateAzurermConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/data-terraform-remote-state-config.mdx b/content/api-reference/go/structs/data-terraform-remote-state-config.mdx index 61f9d93..c8cbefc 100644 --- a/content/api-reference/go/structs/data-terraform-remote-state-config.mdx +++ b/content/api-reference/go/structs/data-terraform-remote-state-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConfig description: CDKTN Core API Reference for DataTerraformRemoteStateConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/data-terraform-remote-state-consul-config.mdx b/content/api-reference/go/structs/data-terraform-remote-state-consul-config.mdx index cfd48b5..ee82043 100644 --- a/content/api-reference/go/structs/data-terraform-remote-state-consul-config.mdx +++ b/content/api-reference/go/structs/data-terraform-remote-state-consul-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConsulConfig description: CDKTN Core API Reference for DataTerraformRemoteStateConsulConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/data-terraform-remote-state-cos-config.mdx b/content/api-reference/go/structs/data-terraform-remote-state-cos-config.mdx index 0938d7b..3f54b89 100644 --- a/content/api-reference/go/structs/data-terraform-remote-state-cos-config.mdx +++ b/content/api-reference/go/structs/data-terraform-remote-state-cos-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateCosConfig description: CDKTN Core API Reference for DataTerraformRemoteStateCosConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/data-terraform-remote-state-gcs-config.mdx b/content/api-reference/go/structs/data-terraform-remote-state-gcs-config.mdx index f5c522a..0f0844f 100644 --- a/content/api-reference/go/structs/data-terraform-remote-state-gcs-config.mdx +++ b/content/api-reference/go/structs/data-terraform-remote-state-gcs-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateGcsConfig description: CDKTN Core API Reference for DataTerraformRemoteStateGcsConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/data-terraform-remote-state-http-config.mdx b/content/api-reference/go/structs/data-terraform-remote-state-http-config.mdx index fb6ea6d..9b79799 100644 --- a/content/api-reference/go/structs/data-terraform-remote-state-http-config.mdx +++ b/content/api-reference/go/structs/data-terraform-remote-state-http-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateHttpConfig description: CDKTN Core API Reference for DataTerraformRemoteStateHttpConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/data-terraform-remote-state-local-config.mdx b/content/api-reference/go/structs/data-terraform-remote-state-local-config.mdx index f230f81..707f606 100644 --- a/content/api-reference/go/structs/data-terraform-remote-state-local-config.mdx +++ b/content/api-reference/go/structs/data-terraform-remote-state-local-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateLocalConfig description: CDKTN Core API Reference for DataTerraformRemoteStateLocalConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/data-terraform-remote-state-oss-config.mdx b/content/api-reference/go/structs/data-terraform-remote-state-oss-config.mdx index 9b24104..30f522d 100644 --- a/content/api-reference/go/structs/data-terraform-remote-state-oss-config.mdx +++ b/content/api-reference/go/structs/data-terraform-remote-state-oss-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateOssConfig description: CDKTN Core API Reference for DataTerraformRemoteStateOssConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/data-terraform-remote-state-pg-config.mdx b/content/api-reference/go/structs/data-terraform-remote-state-pg-config.mdx index 61edcce..898c298 100644 --- a/content/api-reference/go/structs/data-terraform-remote-state-pg-config.mdx +++ b/content/api-reference/go/structs/data-terraform-remote-state-pg-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStatePgConfig description: CDKTN Core API Reference for DataTerraformRemoteStatePgConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/data-terraform-remote-state-remote-config.mdx b/content/api-reference/go/structs/data-terraform-remote-state-remote-config.mdx index 28a5275..938f219 100644 --- a/content/api-reference/go/structs/data-terraform-remote-state-remote-config.mdx +++ b/content/api-reference/go/structs/data-terraform-remote-state-remote-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateRemoteConfig description: CDKTN Core API Reference for DataTerraformRemoteStateRemoteConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/data-terraform-remote-state-s3-config.mdx b/content/api-reference/go/structs/data-terraform-remote-state-s3-config.mdx index 3389687..e3ea54c 100644 --- a/content/api-reference/go/structs/data-terraform-remote-state-s3-config.mdx +++ b/content/api-reference/go/structs/data-terraform-remote-state-s3-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateS3Config description: CDKTN Core API Reference for DataTerraformRemoteStateS3Config in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer @@ -62,6 +62,7 @@ import "github.com/open-constructs/cdk-terrain-go/cdktn" StsRegion: *string, Token: *string, UseLegacyWorkflow: *bool, + UseLockfile: *bool, UsePathStyle: *bool, WorkspaceKeyPrefix: *string, } @@ -121,6 +122,7 @@ import "github.com/open-constructs/cdk-terrain-go/cdktn" | StsRegion | \*string | (Optional) AWS region for STS. | | Token | \*string | (Optional) Multi-Factor Authentication (MFA) token. | | UseLegacyWorkflow | \*bool | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. | +| UseLockfile | \*bool | (Optional) Whether to use a lockfile for locking the state file. | | UsePathStyle | \*bool | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). | | WorkspaceKeyPrefix | \*string | (Optional) Prefix applied to the state path inside the bucket. | @@ -329,7 +331,9 @@ This can also be sourced from the AWS\_DYNAMODB\_ENDPOINT environment variable. *** -### `DynamodbTable`Optional +### ~~`DynamodbTable`~~Optional + +- *Deprecated:* Use useLockfile instead, which uses S3 for locking ```go DynamodbTable *string @@ -833,6 +837,25 @@ This behavior does not align with the authentication flow of the AWS CLI or SDK' *** +### `UseLockfile`Optional + +```go +UseLockfile *bool +``` + +- *Type:* \*bool + +(Optional) Whether to use a lockfile for locking the state file. + +Defaults to false. +State locking is an opt-in feature of the S3 backend. +Locking can be enabled via S3 or DynamoDB (see dynamodbTable). However, DynamoDB-based locking +is deprecated and will be removed in a future minor version. To support migration from older +versions of Terraform that only support DynamoDB-based locking, the S3 (useLockfile) and DynamoDB +(dynamodbTable) arguments can be configured simultaneously. + +*** + ### `UsePathStyle`Optional ```go diff --git a/content/api-reference/go/structs/data-terraform-remote-state-swift-config.mdx b/content/api-reference/go/structs/data-terraform-remote-state-swift-config.mdx index 534aa4d..931d390 100644 --- a/content/api-reference/go/structs/data-terraform-remote-state-swift-config.mdx +++ b/content/api-reference/go/structs/data-terraform-remote-state-swift-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateSwiftConfig description: CDKTN Core API Reference for DataTerraformRemoteStateSwiftConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/encoding-options.mdx b/content/api-reference/go/structs/encoding-options.mdx index 517a838..848c3f9 100644 --- a/content/api-reference/go/structs/encoding-options.mdx +++ b/content/api-reference/go/structs/encoding-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: EncodingOptions description: CDKTN Core API Reference for EncodingOptions in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Properties to string encodings. diff --git a/content/api-reference/go/structs/file-provisioner.mdx b/content/api-reference/go/structs/file-provisioner.mdx index f2e1e1f..964b44e 100644 --- a/content/api-reference/go/structs/file-provisioner.mdx +++ b/content/api-reference/go/structs/file-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: FileProvisioner description: CDKTN Core API Reference for FileProvisioner in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The file provisioner copies files or directories from the machine running Terraform to the newly created resource. diff --git a/content/api-reference/go/structs/gcs-backend-config.mdx b/content/api-reference/go/structs/gcs-backend-config.mdx index 770c24d..bd68bab 100644 --- a/content/api-reference/go/structs/gcs-backend-config.mdx +++ b/content/api-reference/go/structs/gcs-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: GcsBackendConfig description: CDKTN Core API Reference for GcsBackendConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as an object in a configurable prefix in a pre-existing bucket on Google Cloud Storage (GCS). diff --git a/content/api-reference/go/structs/http-backend-config.mdx b/content/api-reference/go/structs/http-backend-config.mdx index c329bc0..80c6f83 100644 --- a/content/api-reference/go/structs/http-backend-config.mdx +++ b/content/api-reference/go/structs/http-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: HttpBackendConfig description: CDKTN Core API Reference for HttpBackendConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state using a simple REST client. diff --git a/content/api-reference/go/structs/lazy-any-value-options.mdx b/content/api-reference/go/structs/lazy-any-value-options.mdx index f2e22b0..09f55ea 100644 --- a/content/api-reference/go/structs/lazy-any-value-options.mdx +++ b/content/api-reference/go/structs/lazy-any-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyAnyValueOptions description: CDKTN Core API Reference for LazyAnyValueOptions in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating lazy untyped tokens. diff --git a/content/api-reference/go/structs/lazy-list-value-options.mdx b/content/api-reference/go/structs/lazy-list-value-options.mdx index 5595b0d..25703cc 100644 --- a/content/api-reference/go/structs/lazy-list-value-options.mdx +++ b/content/api-reference/go/structs/lazy-list-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyListValueOptions description: CDKTN Core API Reference for LazyListValueOptions in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating a lazy list token. diff --git a/content/api-reference/go/structs/lazy-string-value-options.mdx b/content/api-reference/go/structs/lazy-string-value-options.mdx index ae1e4a8..e602d1c 100644 --- a/content/api-reference/go/structs/lazy-string-value-options.mdx +++ b/content/api-reference/go/structs/lazy-string-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyStringValueOptions description: CDKTN Core API Reference for LazyStringValueOptions in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating a lazy string token. diff --git a/content/api-reference/go/structs/local-backend-config.mdx b/content/api-reference/go/structs/local-backend-config.mdx index 6cefa7c..89746c6 100644 --- a/content/api-reference/go/structs/local-backend-config.mdx +++ b/content/api-reference/go/structs/local-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalBackendConfig description: CDKTN Core API Reference for LocalBackendConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The local backend stores state on the local filesystem, locks that state using system APIs, and performs operations locally. diff --git a/content/api-reference/go/structs/local-exec-provisioner.mdx b/content/api-reference/go/structs/local-exec-provisioner.mdx index bf84662..de4c689 100644 --- a/content/api-reference/go/structs/local-exec-provisioner.mdx +++ b/content/api-reference/go/structs/local-exec-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalExecProvisioner description: CDKTN Core API Reference for LocalExecProvisioner in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The local-exec provisioner invokes a local executable after a resource is created. diff --git a/content/api-reference/go/structs/oss-assume-role.mdx b/content/api-reference/go/structs/oss-assume-role.mdx index 9fcf8b1..40b0474 100644 --- a/content/api-reference/go/structs/oss-assume-role.mdx +++ b/content/api-reference/go/structs/oss-assume-role.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssAssumeRole description: CDKTN Core API Reference for OssAssumeRole in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/oss-backend-config.mdx b/content/api-reference/go/structs/oss-backend-config.mdx index b92ed01..ce2c534 100644 --- a/content/api-reference/go/structs/oss-backend-config.mdx +++ b/content/api-reference/go/structs/oss-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssBackendConfig description: CDKTN Core API Reference for OssBackendConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/pg-backend-config.mdx b/content/api-reference/go/structs/pg-backend-config.mdx index ac7aa2f..12bd72a 100644 --- a/content/api-reference/go/structs/pg-backend-config.mdx +++ b/content/api-reference/go/structs/pg-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: PgBackendConfig description: CDKTN Core API Reference for PgBackendConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/postcondition.mdx b/content/api-reference/go/structs/postcondition.mdx index a38a7e2..2944a4c 100644 --- a/content/api-reference/go/structs/postcondition.mdx +++ b/content/api-reference/go/structs/postcondition.mdx @@ -4,7 +4,7 @@ sidebarTitle: Postcondition description: CDKTN Core API Reference for Postcondition in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Terraform checks a postcondition after evaluating the object it is associated with. diff --git a/content/api-reference/go/structs/precondition.mdx b/content/api-reference/go/structs/precondition.mdx index 03699b6..c4b380d 100644 --- a/content/api-reference/go/structs/precondition.mdx +++ b/content/api-reference/go/structs/precondition.mdx @@ -4,7 +4,7 @@ sidebarTitle: Precondition description: CDKTN Core API Reference for Precondition in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Terraform checks a precondition before evaluating the object it is associated with. diff --git a/content/api-reference/go/structs/remote-backend-config.mdx b/content/api-reference/go/structs/remote-backend-config.mdx index f12c163..8e5ae9f 100644 --- a/content/api-reference/go/structs/remote-backend-config.mdx +++ b/content/api-reference/go/structs/remote-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteBackendConfig description: CDKTN Core API Reference for RemoteBackendConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/remote-exec-provisioner.mdx b/content/api-reference/go/structs/remote-exec-provisioner.mdx index 0e7c900..175bc5a 100644 --- a/content/api-reference/go/structs/remote-exec-provisioner.mdx +++ b/content/api-reference/go/structs/remote-exec-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteExecProvisioner description: CDKTN Core API Reference for RemoteExecProvisioner in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The remote-exec provisioner invokes a script on a remote resource after it is created. diff --git a/content/api-reference/go/structs/resolve-options.mdx b/content/api-reference/go/structs/resolve-options.mdx index 9dbe9c4..171c0fd 100644 --- a/content/api-reference/go/structs/resolve-options.mdx +++ b/content/api-reference/go/structs/resolve-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: ResolveOptions description: CDKTN Core API Reference for ResolveOptions in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options to the resolve() operation. diff --git a/content/api-reference/go/structs/s3-backend-assume-role-config.mdx b/content/api-reference/go/structs/s3-backend-assume-role-config.mdx index d9a93ff..2fb9538 100644 --- a/content/api-reference/go/structs/s3-backend-assume-role-config.mdx +++ b/content/api-reference/go/structs/s3-backend-assume-role-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendAssumeRoleConfig description: CDKTN Core API Reference for S3BackendAssumeRoleConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/s3-backend-assume-role-with-web-identity-config.mdx b/content/api-reference/go/structs/s3-backend-assume-role-with-web-identity-config.mdx index d5d0e85..e95f4c3 100644 --- a/content/api-reference/go/structs/s3-backend-assume-role-with-web-identity-config.mdx +++ b/content/api-reference/go/structs/s3-backend-assume-role-with-web-identity-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendAssumeRoleWithWebIdentityConfig description: CDKTN Core API Reference for S3BackendAssumeRoleWithWebIdentityConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/s3-backend-config.mdx b/content/api-reference/go/structs/s3-backend-config.mdx index 78aaf88..b85f179 100644 --- a/content/api-reference/go/structs/s3-backend-config.mdx +++ b/content/api-reference/go/structs/s3-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendConfig description: CDKTN Core API Reference for S3BackendConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as a given key in a given bucket on Amazon S3. @@ -76,6 +76,7 @@ import "github.com/open-constructs/cdk-terrain-go/cdktn" StsRegion: *string, Token: *string, UseLegacyWorkflow: *bool, + UseLockfile: *bool, UsePathStyle: *bool, WorkspaceKeyPrefix: *string, } @@ -133,6 +134,7 @@ import "github.com/open-constructs/cdk-terrain-go/cdktn" | StsRegion | \*string | (Optional) AWS region for STS. | | Token | \*string | (Optional) Multi-Factor Authentication (MFA) token. | | UseLegacyWorkflow | \*bool | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. | +| UseLockfile | \*bool | (Optional) Whether to use a lockfile for locking the state file. | | UsePathStyle | \*bool | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). | | WorkspaceKeyPrefix | \*string | (Optional) Prefix applied to the state path inside the bucket. | @@ -321,7 +323,9 @@ This can also be sourced from the AWS\_DYNAMODB\_ENDPOINT environment variable. *** -### `DynamodbTable`Optional +### ~~`DynamodbTable`~~Optional + +- *Deprecated:* Use useLockfile instead, which uses S3 for locking ```go DynamodbTable *string @@ -825,6 +829,25 @@ This behavior does not align with the authentication flow of the AWS CLI or SDK' *** +### `UseLockfile`Optional + +```go +UseLockfile *bool +``` + +- *Type:* \*bool + +(Optional) Whether to use a lockfile for locking the state file. + +Defaults to false. +State locking is an opt-in feature of the S3 backend. +Locking can be enabled via S3 or DynamoDB (see dynamodbTable). However, DynamoDB-based locking +is deprecated and will be removed in a future minor version. To support migration from older +versions of Terraform that only support DynamoDB-based locking, the S3 (useLockfile) and DynamoDB +(dynamodbTable) arguments can be configured simultaneously. + +*** + ### `UsePathStyle`Optional ```go diff --git a/content/api-reference/go/structs/s3-backend-endpoint-config.mdx b/content/api-reference/go/structs/s3-backend-endpoint-config.mdx index 580462e..bdbcfb1 100644 --- a/content/api-reference/go/structs/s3-backend-endpoint-config.mdx +++ b/content/api-reference/go/structs/s3-backend-endpoint-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendEndpointConfig description: CDKTN Core API Reference for S3BackendEndpointConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/ssh-provisioner-connection.mdx b/content/api-reference/go/structs/ssh-provisioner-connection.mdx index 0f80722..a4a749a 100644 --- a/content/api-reference/go/structs/ssh-provisioner-connection.mdx +++ b/content/api-reference/go/structs/ssh-provisioner-connection.mdx @@ -4,7 +4,7 @@ sidebarTitle: SSHProvisionerConnection description: CDKTN Core API Reference for SSHProvisionerConnection in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect. diff --git a/content/api-reference/go/structs/stack-annotation.mdx b/content/api-reference/go/structs/stack-annotation.mdx index f899e68..3e1a7cc 100644 --- a/content/api-reference/go/structs/stack-annotation.mdx +++ b/content/api-reference/go/structs/stack-annotation.mdx @@ -4,7 +4,7 @@ sidebarTitle: StackAnnotation description: CDKTN Core API Reference for StackAnnotation in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/stack-manifest.mdx b/content/api-reference/go/structs/stack-manifest.mdx index 9e7e299..e44e344 100644 --- a/content/api-reference/go/structs/stack-manifest.mdx +++ b/content/api-reference/go/structs/stack-manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: StackManifest description: CDKTN Core API Reference for StackManifest in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/swift-backend-config.mdx b/content/api-reference/go/structs/swift-backend-config.mdx index a9ef9b0..ac38f7c 100644 --- a/content/api-reference/go/structs/swift-backend-config.mdx +++ b/content/api-reference/go/structs/swift-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: SwiftBackendConfig description: CDKTN Core API Reference for SwiftBackendConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-asset-config.mdx b/content/api-reference/go/structs/terraform-asset-config.mdx index e4aeabf..f246ea2 100644 --- a/content/api-reference/go/structs/terraform-asset-config.mdx +++ b/content/api-reference/go/structs/terraform-asset-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformAssetConfig description: CDKTN Core API Reference for TerraformAssetConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-condition.mdx b/content/api-reference/go/structs/terraform-condition.mdx index 3841c70..e8f55d0 100644 --- a/content/api-reference/go/structs/terraform-condition.mdx +++ b/content/api-reference/go/structs/terraform-condition.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformCondition description: CDKTN Core API Reference for TerraformCondition in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-constructor.mdx b/content/api-reference/go/structs/terraform-constructor.mdx index 0b12b04..a9a3ec6 100644 --- a/content/api-reference/go/structs/terraform-constructor.mdx +++ b/content/api-reference/go/structs/terraform-constructor.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformConstructor description: CDKTN Core API Reference for TerraformConstructor in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-element-metadata.mdx b/content/api-reference/go/structs/terraform-element-metadata.mdx index 630a1e7..2de7594 100644 --- a/content/api-reference/go/structs/terraform-element-metadata.mdx +++ b/content/api-reference/go/structs/terraform-element-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformElementMetadata description: CDKTN Core API Reference for TerraformElementMetadata in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-hcl-module-config.mdx b/content/api-reference/go/structs/terraform-hcl-module-config.mdx index 30448de..59c5362 100644 --- a/content/api-reference/go/structs/terraform-hcl-module-config.mdx +++ b/content/api-reference/go/structs/terraform-hcl-module-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformHclModuleConfig description: CDKTN Core API Reference for TerraformHclModuleConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-meta-arguments.mdx b/content/api-reference/go/structs/terraform-meta-arguments.mdx index ae45e43..7f4be3f 100644 --- a/content/api-reference/go/structs/terraform-meta-arguments.mdx +++ b/content/api-reference/go/structs/terraform-meta-arguments.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformMetaArguments description: CDKTN Core API Reference for TerraformMetaArguments in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-module-config.mdx b/content/api-reference/go/structs/terraform-module-config.mdx index a05073d..4b8d58a 100644 --- a/content/api-reference/go/structs/terraform-module-config.mdx +++ b/content/api-reference/go/structs/terraform-module-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleConfig description: CDKTN Core API Reference for TerraformModuleConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-module-provider.mdx b/content/api-reference/go/structs/terraform-module-provider.mdx index f5da538..120d41e 100644 --- a/content/api-reference/go/structs/terraform-module-provider.mdx +++ b/content/api-reference/go/structs/terraform-module-provider.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleProvider description: CDKTN Core API Reference for TerraformModuleProvider in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-module-user-config.mdx b/content/api-reference/go/structs/terraform-module-user-config.mdx index 23ccad5..163874f 100644 --- a/content/api-reference/go/structs/terraform-module-user-config.mdx +++ b/content/api-reference/go/structs/terraform-module-user-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleUserConfig description: CDKTN Core API Reference for TerraformModuleUserConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-output-config.mdx b/content/api-reference/go/structs/terraform-output-config.mdx index 97b0a92..ad98739 100644 --- a/content/api-reference/go/structs/terraform-output-config.mdx +++ b/content/api-reference/go/structs/terraform-output-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformOutputConfig description: CDKTN Core API Reference for TerraformOutputConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-provider-config.mdx b/content/api-reference/go/structs/terraform-provider-config.mdx index 40aa5b3..d42bfd2 100644 --- a/content/api-reference/go/structs/terraform-provider-config.mdx +++ b/content/api-reference/go/structs/terraform-provider-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProviderConfig description: CDKTN Core API Reference for TerraformProviderConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-provider-generator-metadata.mdx b/content/api-reference/go/structs/terraform-provider-generator-metadata.mdx index 90c7ce2..c9bb85c 100644 --- a/content/api-reference/go/structs/terraform-provider-generator-metadata.mdx +++ b/content/api-reference/go/structs/terraform-provider-generator-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProviderGeneratorMetadata description: CDKTN Core API Reference for TerraformProviderGeneratorMetadata in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-resource-config.mdx b/content/api-reference/go/structs/terraform-resource-config.mdx index f2f95d3..bbce0e9 100644 --- a/content/api-reference/go/structs/terraform-resource-config.mdx +++ b/content/api-reference/go/structs/terraform-resource-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceConfig description: CDKTN Core API Reference for TerraformResourceConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-resource-import.mdx b/content/api-reference/go/structs/terraform-resource-import.mdx index d13c105..d796865 100644 --- a/content/api-reference/go/structs/terraform-resource-import.mdx +++ b/content/api-reference/go/structs/terraform-resource-import.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceImport description: CDKTN Core API Reference for TerraformResourceImport in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-resource-lifecycle.mdx b/content/api-reference/go/structs/terraform-resource-lifecycle.mdx index 7d7d44b..637ec6b 100644 --- a/content/api-reference/go/structs/terraform-resource-lifecycle.mdx +++ b/content/api-reference/go/structs/terraform-resource-lifecycle.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceLifecycle description: CDKTN Core API Reference for TerraformResourceLifecycle in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-resource-move-by-id.mdx b/content/api-reference/go/structs/terraform-resource-move-by-id.mdx index a6c60d4..ccb6cdd 100644 --- a/content/api-reference/go/structs/terraform-resource-move-by-id.mdx +++ b/content/api-reference/go/structs/terraform-resource-move-by-id.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceMoveById description: CDKTN Core API Reference for TerraformResourceMoveById in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-resource-move-by-target.mdx b/content/api-reference/go/structs/terraform-resource-move-by-target.mdx index 3ce4c16..596a500 100644 --- a/content/api-reference/go/structs/terraform-resource-move-by-target.mdx +++ b/content/api-reference/go/structs/terraform-resource-move-by-target.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceMoveByTarget description: CDKTN Core API Reference for TerraformResourceMoveByTarget in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-stack-metadata.mdx b/content/api-reference/go/structs/terraform-stack-metadata.mdx index da26b4b..988ad7e 100644 --- a/content/api-reference/go/structs/terraform-stack-metadata.mdx +++ b/content/api-reference/go/structs/terraform-stack-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformStackMetadata description: CDKTN Core API Reference for TerraformStackMetadata in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-variable-config.mdx b/content/api-reference/go/structs/terraform-variable-config.mdx index 85fde0d..6da91f7 100644 --- a/content/api-reference/go/structs/terraform-variable-config.mdx +++ b/content/api-reference/go/structs/terraform-variable-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariableConfig description: CDKTN Core API Reference for TerraformVariableConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/terraform-variable-validation-config.mdx b/content/api-reference/go/structs/terraform-variable-validation-config.mdx index c9fae97..0040d06 100644 --- a/content/api-reference/go/structs/terraform-variable-validation-config.mdx +++ b/content/api-reference/go/structs/terraform-variable-validation-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariableValidationConfig description: CDKTN Core API Reference for TerraformVariableValidationConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Add one or more validation blocks within the variable block to specify custom conditions. diff --git a/content/api-reference/go/structs/testing-app-config.mdx b/content/api-reference/go/structs/testing-app-config.mdx index f04f367..2f44236 100644 --- a/content/api-reference/go/structs/testing-app-config.mdx +++ b/content/api-reference/go/structs/testing-app-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TestingAppConfig description: CDKTN Core API Reference for TestingAppConfig in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/go/structs/winrm-provisioner-connection.mdx b/content/api-reference/go/structs/winrm-provisioner-connection.mdx index 9b4acf4..2a26661 100644 --- a/content/api-reference/go/structs/winrm-provisioner-connection.mdx +++ b/content/api-reference/go/structs/winrm-provisioner-connection.mdx @@ -4,7 +4,7 @@ sidebarTitle: WinrmProvisionerConnection description: CDKTN Core API Reference for WinrmProvisionerConnection in Go. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect. diff --git a/content/api-reference/java/classes/annotations.mdx b/content/api-reference/java/classes/annotations.mdx index 9c265ed..ae95def 100644 --- a/content/api-reference/java/classes/annotations.mdx +++ b/content/api-reference/java/classes/annotations.mdx @@ -4,7 +4,7 @@ sidebarTitle: Annotations description: CDKTN Core API Reference for Annotations in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Includes API for attaching annotations such as warning messages to constructs. diff --git a/content/api-reference/java/classes/any-list-list.mdx b/content/api-reference/java/classes/any-list-list.mdx index 0e7de7d..ff7bc64 100644 --- a/content/api-reference/java/classes/any-list-list.mdx +++ b/content/api-reference/java/classes/any-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyListList description: CDKTN Core API Reference for AnyListList in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/any-list-map.mdx b/content/api-reference/java/classes/any-list-map.mdx index 17f9749..dcee1d0 100644 --- a/content/api-reference/java/classes/any-list-map.mdx +++ b/content/api-reference/java/classes/any-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyListMap description: CDKTN Core API Reference for AnyListMap in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/any-map-list.mdx b/content/api-reference/java/classes/any-map-list.mdx index 35111b8..dab3227 100644 --- a/content/api-reference/java/classes/any-map-list.mdx +++ b/content/api-reference/java/classes/any-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyMapList description: CDKTN Core API Reference for AnyMapList in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/any-map.mdx b/content/api-reference/java/classes/any-map.mdx index f0730b0..6cb4d8b 100644 --- a/content/api-reference/java/classes/any-map.mdx +++ b/content/api-reference/java/classes/any-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyMap description: CDKTN Core API Reference for AnyMap in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/java/classes/aspects.mdx b/content/api-reference/java/classes/aspects.mdx index 94b9f9a..a8e9094 100644 --- a/content/api-reference/java/classes/aspects.mdx +++ b/content/api-reference/java/classes/aspects.mdx @@ -4,7 +4,7 @@ sidebarTitle: Aspects description: CDKTN Core API Reference for Aspects in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis. diff --git a/content/api-reference/java/classes/assertion-return.mdx b/content/api-reference/java/classes/assertion-return.mdx index 191dab3..07675c7 100644 --- a/content/api-reference/java/classes/assertion-return.mdx +++ b/content/api-reference/java/classes/assertion-return.mdx @@ -4,7 +4,7 @@ sidebarTitle: AssertionReturn description: CDKTN Core API Reference for AssertionReturn in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Class representing the contents of a return by an assertion. diff --git a/content/api-reference/java/classes/boolean-list-list.mdx b/content/api-reference/java/classes/boolean-list-list.mdx index f0fe239..676be15 100644 --- a/content/api-reference/java/classes/boolean-list-list.mdx +++ b/content/api-reference/java/classes/boolean-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanListList description: CDKTN Core API Reference for BooleanListList in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/boolean-list-map.mdx b/content/api-reference/java/classes/boolean-list-map.mdx index 1978abf..44cde72 100644 --- a/content/api-reference/java/classes/boolean-list-map.mdx +++ b/content/api-reference/java/classes/boolean-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanListMap description: CDKTN Core API Reference for BooleanListMap in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/boolean-list.mdx b/content/api-reference/java/classes/boolean-list.mdx index 21118be..73a855e 100644 --- a/content/api-reference/java/classes/boolean-list.mdx +++ b/content/api-reference/java/classes/boolean-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanList description: CDKTN Core API Reference for BooleanList in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/boolean-map-list.mdx b/content/api-reference/java/classes/boolean-map-list.mdx index 635072d..1cac52e 100644 --- a/content/api-reference/java/classes/boolean-map-list.mdx +++ b/content/api-reference/java/classes/boolean-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanMapList description: CDKTN Core API Reference for BooleanMapList in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/boolean-map.mdx b/content/api-reference/java/classes/boolean-map.mdx index 1d2c39c..b7b53d0 100644 --- a/content/api-reference/java/classes/boolean-map.mdx +++ b/content/api-reference/java/classes/boolean-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanMap description: CDKTN Core API Reference for BooleanMap in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/java/classes/cloud-workspace.mdx b/content/api-reference/java/classes/cloud-workspace.mdx index ddc1862..21cc8bb 100644 --- a/content/api-reference/java/classes/cloud-workspace.mdx +++ b/content/api-reference/java/classes/cloud-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudWorkspace description: CDKTN Core API Reference for CloudWorkspace in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} A cloud workspace can either be a single named workspace, or a list of tagged workspaces. diff --git a/content/api-reference/java/classes/complex-computed-list.mdx b/content/api-reference/java/classes/complex-computed-list.mdx index 11aa592..414afc2 100644 --- a/content/api-reference/java/classes/complex-computed-list.mdx +++ b/content/api-reference/java/classes/complex-computed-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexComputedList description: CDKTN Core API Reference for ComplexComputedList in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IInterpolatingParent, IResolvable, ITerraformAddressable diff --git a/content/api-reference/java/classes/complex-list.mdx b/content/api-reference/java/classes/complex-list.mdx index e996d7a..920d526 100644 --- a/content/api-reference/java/classes/complex-list.mdx +++ b/content/api-reference/java/classes/complex-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexList description: CDKTN Core API Reference for ComplexList in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/java/classes/complex-map.mdx b/content/api-reference/java/classes/complex-map.mdx index 6acc93a..4e3423b 100644 --- a/content/api-reference/java/classes/complex-map.mdx +++ b/content/api-reference/java/classes/complex-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexMap description: CDKTN Core API Reference for ComplexMap in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/java/classes/complex-object.mdx b/content/api-reference/java/classes/complex-object.mdx index d103360..c09488c 100644 --- a/content/api-reference/java/classes/complex-object.mdx +++ b/content/api-reference/java/classes/complex-object.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexObject description: CDKTN Core API Reference for ComplexObject in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IInterpolatingParent, IResolvable, ITerraformAddressable diff --git a/content/api-reference/java/classes/default-token-resolver.mdx b/content/api-reference/java/classes/default-token-resolver.mdx index 29adcc1..cafa4c9 100644 --- a/content/api-reference/java/classes/default-token-resolver.mdx +++ b/content/api-reference/java/classes/default-token-resolver.mdx @@ -4,7 +4,7 @@ sidebarTitle: DefaultTokenResolver description: CDKTN Core API Reference for DefaultTokenResolver in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITokenResolver diff --git a/content/api-reference/java/classes/dynamic-list-terraform-iterator.mdx b/content/api-reference/java/classes/dynamic-list-terraform-iterator.mdx index 75d87e2..c8faf5b 100644 --- a/content/api-reference/java/classes/dynamic-list-terraform-iterator.mdx +++ b/content/api-reference/java/classes/dynamic-list-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: DynamicListTerraformIterator description: CDKTN Core API Reference for DynamicListTerraformIterator in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/fn-generated.mdx b/content/api-reference/java/classes/fn-generated.mdx index 8d2abad..ee22627 100644 --- a/content/api-reference/java/classes/fn-generated.mdx +++ b/content/api-reference/java/classes/fn-generated.mdx @@ -4,7 +4,7 @@ sidebarTitle: FnGenerated description: CDKTN Core API Reference for FnGenerated in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -29,6 +29,7 @@ new FnGenerated(); | anytrue | [anytrue](https://developer.hashicorp.com/terraform/language/functions/anytrue) returns `true` if any element in a given collection is `true` or `"true"`. It also returns `false` if the collection is empty. | | base64decode | [base64decode](https://developer.hashicorp.com/terraform/language/functions/base64decode) takes a string containing a Base64 character sequence and returns the original string. | | base64encode | [base64encode](https://developer.hashicorp.com/terraform/language/functions/base64encode) applies Base64 encoding to a string. | +| base64gunzip | [base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. | | base64gzip | [base64gzip](https://developer.hashicorp.com/terraform/language/functions/base64gzip) compresses a string with gzip and then encodes the result in Base64 encoding. | | base64sha256 | [base64sha256](https://developer.hashicorp.com/terraform/language/functions/base64sha256) computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()` returns hexadecimal representation. | | base64sha512 | [base64sha512](https://developer.hashicorp.com/terraform/language/functions/base64sha512) computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha512("test"))` since `sha512()` returns hexadecimal representation. | @@ -37,6 +38,7 @@ new FnGenerated(); | ceil | [ceil](https://developer.hashicorp.com/terraform/language/functions/ceil) returns the closest whole number that is greater than or equal to the given value, which may be a fraction. | | chomp | [chomp](https://developer.hashicorp.com/terraform/language/functions/chomp) removes newline characters at the end of a string. | | chunklist | [chunklist](https://developer.hashicorp.com/terraform/language/functions/chunklist) splits a single list into fixed-size chunks, returning a list of lists. | +| cidrcontains | [cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. | | cidrhost | [cidrhost](https://developer.hashicorp.com/terraform/language/functions/cidrhost) calculates a full host IP address for a given host number within a given IP network address prefix. | | cidrnetmask | [cidrnetmask](https://developer.hashicorp.com/terraform/language/functions/cidrnetmask) converts an IPv4 address prefix given in CIDR notation into a subnet mask address. | | cidrsubnet | [cidrsubnet](https://developer.hashicorp.com/terraform/language/functions/cidrsubnet) calculates a subnet address within given IP network address prefix. | @@ -46,11 +48,13 @@ new FnGenerated(); | compact | [compact](https://developer.hashicorp.com/terraform/language/functions/compact) takes a list of strings and returns a new list with any empty string elements removed. | | concat | [concat](https://developer.hashicorp.com/terraform/language/functions/concat) takes two or more lists and combines them into a single list. | | contains | [contains](https://developer.hashicorp.com/terraform/language/functions/contains) determines whether a given list or set contains a given single value as one of its elements. | +| convert | [convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. | | csvdecode | [csvdecode](https://developer.hashicorp.com/terraform/language/functions/csvdecode) decodes a string containing CSV-formatted data and produces a list of maps representing that data. | | dirname | [dirname](https://developer.hashicorp.com/terraform/language/functions/dirname) takes a string containing a filesystem path and removes the last portion from it. | | distinct | [distinct](https://developer.hashicorp.com/terraform/language/functions/distinct) takes a list and returns a new list with any duplicate elements removed. | | element | [element](https://developer.hashicorp.com/terraform/language/functions/element) retrieves a single element from a list. | | endswith | [endswith](https://developer.hashicorp.com/terraform/language/functions/endswith) takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix. | +| ephemeralasnull | [ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. | | file | [file](https://developer.hashicorp.com/terraform/language/functions/file) reads the contents of a file at the given path and returns them as a string. | | filebase64 | [filebase64](https://developer.hashicorp.com/terraform/language/functions/filebase64) reads the contents of a file at the given path and returns them as a base64-encoded string. | | filebase64sha256 | [filebase64sha256](https://developer.hashicorp.com/terraform/language/functions/filebase64sha256) is a variant of `base64sha256` that hashes the contents of a given file rather than a literal string. | @@ -68,6 +72,7 @@ new FnGenerated(); | formatlist | [formatlist](https://developer.hashicorp.com/terraform/language/functions/formatlist) produces a list of strings by formatting a number of other values according to a specification string. | | indent | [indent](https://developer.hashicorp.com/terraform/language/functions/indent) adds a given number of spaces to the beginnings of all but the first line in a given multi-line string. | | index | [index](https://developer.hashicorp.com/terraform/language/functions/index) finds the element index for a given value in a list. | +| issensitive | [issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. | | jsondecode | [jsondecode](https://developer.hashicorp.com/terraform/language/functions/jsondecode) interprets a given string as JSON, returning a representation of the result of decoding that string. | | jsonencode | [jsonencode](https://developer.hashicorp.com/terraform/language/functions/jsonencode) encodes a given value to a string using JSON syntax. | | keys | [keys](https://developer.hashicorp.com/terraform/language/functions/keys) takes a map and returns a list containing the keys from that map. | @@ -108,6 +113,7 @@ new FnGenerated(); | substr | [substr](https://developer.hashicorp.com/terraform/language/functions/substr) extracts a substring from a given string by offset and (maximum) length. | | sum | [sum](https://developer.hashicorp.com/terraform/language/functions/sum) takes a list or set of numbers and returns the sum of those numbers. | | templatefile | [templatefile](https://developer.hashicorp.com/terraform/language/functions/templatefile) reads the file at the given path and renders its content as a template using a supplied set of template variables. | +| templatestring | [templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. | | textdecodebase64 | [textdecodebase64](https://developer.hashicorp.com/terraform/language/functions/textdecodebase64) function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding. | | textencodebase64 | [textencodebase64](https://developer.hashicorp.com/terraform/language/functions/textencodebase64) encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters. | | timeadd | [timeadd](https://developer.hashicorp.com/terraform/language/functions/timeadd) adds a duration to a timestamp, returning a new timestamp. | @@ -127,6 +133,7 @@ new FnGenerated(); | trimsuffix | [trimsuffix](https://developer.hashicorp.com/terraform/language/functions/trimsuffix) removes the specified suffix from the end of the given string. | | try | [try](https://developer.hashicorp.com/terraform/language/functions/try) evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors. | | upper | [upper](https://developer.hashicorp.com/terraform/language/functions/upper) converts all cased letters in the given string to uppercase. | +| urldecode | [urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. | | urlencode | [urlencode](https://developer.hashicorp.com/terraform/language/functions/urlencode) applies URL encoding to a given string. | | uuid | [uuid](https://developer.hashicorp.com/terraform/language/functions/uuid) generates a unique identifier string. | | uuidv5 | [uuidv5](https://developer.hashicorp.com/terraform/language/functions/uuidv5) generates a *name-based* UUID, as described in [RFC 4122 section 4.3](https://tools.ietf.org/html/rfc4122#section-4.3), also known as a "version 5" UUID. | @@ -233,6 +240,22 @@ FnGenerated.base64encode(java.lang.String str) *** +### `base64gunzip` + +```java +import io.cdktn.cdktn.FnGenerated; + +FnGenerated.base64gunzip(java.lang.String str) +``` + +[base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. + +#### `str`Required + +- *Type:* java.lang.String + +*** + ### `base64gzip` ```java @@ -367,6 +390,28 @@ FnGenerated.chunklist(java.util.List list, java.lang.Number si *** +### `cidrcontains` + +```java +import io.cdktn.cdktn.FnGenerated; + +FnGenerated.cidrcontains(java.lang.String containing_prefix, java.lang.String contained_ip_or_prefix) +``` + +[cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. + +#### `containing_prefix`Required + +- *Type:* java.lang.String + +*** + +#### `contained_ip_or_prefix`Required + +- *Type:* java.lang.String + +*** + ### `cidrhost` ```java @@ -541,6 +586,28 @@ FnGenerated.contains(java.lang.Object list, java.lang.Object value) *** +### `convert` + +```java +import io.cdktn.cdktn.FnGenerated; + +FnGenerated.convert(java.lang.Object value, java.lang.Object type) +``` + +[convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. + +#### `value`Required + +- *Type:* java.lang.Object + +*** + +#### `type`Required + +- *Type:* java.lang.Object + +*** + ### `csvdecode` ```java @@ -633,6 +700,22 @@ FnGenerated.endswith(java.lang.String str, java.lang.String suffix) *** +### `ephemeralasnull` + +```java +import io.cdktn.cdktn.FnGenerated; + +FnGenerated.ephemeralasnull(java.lang.Object value) +``` + +[ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. + +#### `value`Required + +- *Type:* java.lang.Object + +*** + ### `file` ```java @@ -941,6 +1024,22 @@ FnGenerated.index(java.lang.Object list, java.lang.Object value) *** +### `issensitive` + +```java +import io.cdktn.cdktn.FnGenerated; + +FnGenerated.issensitive(java.lang.Object value) +``` + +[issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. + +#### `value`Required + +- *Type:* java.lang.Object + +*** + ### `jsondecode` ```java @@ -1701,6 +1800,28 @@ FnGenerated.templatefile(java.lang.String path, java.lang.Object vars) *** +### `templatestring` + +```java +import io.cdktn.cdktn.FnGenerated; + +FnGenerated.templatestring(java.lang.String template, java.lang.Object vars) +``` + +[templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. + +#### `template`Required + +- *Type:* java.lang.String + +*** + +#### `vars`Required + +- *Type:* java.lang.Object + +*** + ### `textdecodebase64` ```java @@ -2041,6 +2162,22 @@ FnGenerated.upper(java.lang.String str) *** +### `urldecode` + +```java +import io.cdktn.cdktn.FnGenerated; + +FnGenerated.urldecode(java.lang.String str) +``` + +[urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. + +#### `str`Required + +- *Type:* java.lang.String + +*** + ### `urlencode` ```java diff --git a/content/api-reference/java/classes/fn.mdx b/content/api-reference/java/classes/fn.mdx index d05dff7..d5b30be 100644 --- a/content/api-reference/java/classes/fn.mdx +++ b/content/api-reference/java/classes/fn.mdx @@ -4,7 +4,7 @@ sidebarTitle: Fn description: CDKTN Core API Reference for Fn in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -29,6 +29,7 @@ new Fn(); | anytrue | [anytrue](https://developer.hashicorp.com/terraform/language/functions/anytrue) returns `true` if any element in a given collection is `true` or `"true"`. It also returns `false` if the collection is empty. | | base64decode | [base64decode](https://developer.hashicorp.com/terraform/language/functions/base64decode) takes a string containing a Base64 character sequence and returns the original string. | | base64encode | [base64encode](https://developer.hashicorp.com/terraform/language/functions/base64encode) applies Base64 encoding to a string. | +| base64gunzip | [base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. | | base64gzip | [base64gzip](https://developer.hashicorp.com/terraform/language/functions/base64gzip) compresses a string with gzip and then encodes the result in Base64 encoding. | | base64sha256 | [base64sha256](https://developer.hashicorp.com/terraform/language/functions/base64sha256) computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()` returns hexadecimal representation. | | base64sha512 | [base64sha512](https://developer.hashicorp.com/terraform/language/functions/base64sha512) computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha512("test"))` since `sha512()` returns hexadecimal representation. | @@ -37,6 +38,7 @@ new Fn(); | ceil | [ceil](https://developer.hashicorp.com/terraform/language/functions/ceil) returns the closest whole number that is greater than or equal to the given value, which may be a fraction. | | chomp | [chomp](https://developer.hashicorp.com/terraform/language/functions/chomp) removes newline characters at the end of a string. | | chunklist | [chunklist](https://developer.hashicorp.com/terraform/language/functions/chunklist) splits a single list into fixed-size chunks, returning a list of lists. | +| cidrcontains | [cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. | | cidrhost | [cidrhost](https://developer.hashicorp.com/terraform/language/functions/cidrhost) calculates a full host IP address for a given host number within a given IP network address prefix. | | cidrnetmask | [cidrnetmask](https://developer.hashicorp.com/terraform/language/functions/cidrnetmask) converts an IPv4 address prefix given in CIDR notation into a subnet mask address. | | cidrsubnet | [cidrsubnet](https://developer.hashicorp.com/terraform/language/functions/cidrsubnet) calculates a subnet address within given IP network address prefix. | @@ -46,11 +48,13 @@ new Fn(); | compact | [compact](https://developer.hashicorp.com/terraform/language/functions/compact) takes a list of strings and returns a new list with any empty string elements removed. | | concat | [concat](https://developer.hashicorp.com/terraform/language/functions/concat) takes two or more lists and combines them into a single list. | | contains | [contains](https://developer.hashicorp.com/terraform/language/functions/contains) determines whether a given list or set contains a given single value as one of its elements. | +| convert | [convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. | | csvdecode | [csvdecode](https://developer.hashicorp.com/terraform/language/functions/csvdecode) decodes a string containing CSV-formatted data and produces a list of maps representing that data. | | dirname | [dirname](https://developer.hashicorp.com/terraform/language/functions/dirname) takes a string containing a filesystem path and removes the last portion from it. | | distinct | [distinct](https://developer.hashicorp.com/terraform/language/functions/distinct) takes a list and returns a new list with any duplicate elements removed. | | element | [element](https://developer.hashicorp.com/terraform/language/functions/element) retrieves a single element from a list. | | endswith | [endswith](https://developer.hashicorp.com/terraform/language/functions/endswith) takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix. | +| ephemeralasnull | [ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. | | file | [file](https://developer.hashicorp.com/terraform/language/functions/file) reads the contents of a file at the given path and returns them as a string. | | filebase64 | [filebase64](https://developer.hashicorp.com/terraform/language/functions/filebase64) reads the contents of a file at the given path and returns them as a base64-encoded string. | | filebase64sha256 | [filebase64sha256](https://developer.hashicorp.com/terraform/language/functions/filebase64sha256) is a variant of `base64sha256` that hashes the contents of a given file rather than a literal string. | @@ -68,6 +72,7 @@ new Fn(); | formatlist | [formatlist](https://developer.hashicorp.com/terraform/language/functions/formatlist) produces a list of strings by formatting a number of other values according to a specification string. | | indent | [indent](https://developer.hashicorp.com/terraform/language/functions/indent) adds a given number of spaces to the beginnings of all but the first line in a given multi-line string. | | index | [index](https://developer.hashicorp.com/terraform/language/functions/index) finds the element index for a given value in a list. | +| issensitive | [issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. | | jsondecode | [jsondecode](https://developer.hashicorp.com/terraform/language/functions/jsondecode) interprets a given string as JSON, returning a representation of the result of decoding that string. | | jsonencode | [jsonencode](https://developer.hashicorp.com/terraform/language/functions/jsonencode) encodes a given value to a string using JSON syntax. | | keys | [keys](https://developer.hashicorp.com/terraform/language/functions/keys) takes a map and returns a list containing the keys from that map. | @@ -108,6 +113,7 @@ new Fn(); | substr | [substr](https://developer.hashicorp.com/terraform/language/functions/substr) extracts a substring from a given string by offset and (maximum) length. | | sum | [sum](https://developer.hashicorp.com/terraform/language/functions/sum) takes a list or set of numbers and returns the sum of those numbers. | | templatefile | [templatefile](https://developer.hashicorp.com/terraform/language/functions/templatefile) reads the file at the given path and renders its content as a template using a supplied set of template variables. | +| templatestring | [templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. | | textdecodebase64 | [textdecodebase64](https://developer.hashicorp.com/terraform/language/functions/textdecodebase64) function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding. | | textencodebase64 | [textencodebase64](https://developer.hashicorp.com/terraform/language/functions/textencodebase64) encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters. | | timeadd | [timeadd](https://developer.hashicorp.com/terraform/language/functions/timeadd) adds a duration to a timestamp, returning a new timestamp. | @@ -127,6 +133,7 @@ new Fn(); | trimsuffix | [trimsuffix](https://developer.hashicorp.com/terraform/language/functions/trimsuffix) removes the specified suffix from the end of the given string. | | try | [try](https://developer.hashicorp.com/terraform/language/functions/try) evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors. | | upper | [upper](https://developer.hashicorp.com/terraform/language/functions/upper) converts all cased letters in the given string to uppercase. | +| urldecode | [urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. | | urlencode | [urlencode](https://developer.hashicorp.com/terraform/language/functions/urlencode) applies URL encoding to a given string. | | uuid | [uuid](https://developer.hashicorp.com/terraform/language/functions/uuid) generates a unique identifier string. | | uuidv5 | [uuidv5](https://developer.hashicorp.com/terraform/language/functions/uuidv5) generates a *name-based* UUID, as described in [RFC 4122 section 4.3](https://tools.ietf.org/html/rfc4122#section-4.3), also known as a "version 5" UUID. | @@ -240,6 +247,22 @@ Fn.base64encode(java.lang.String str) *** +### `base64gunzip` + +```java +import io.cdktn.cdktn.Fn; + +Fn.base64gunzip(java.lang.String str) +``` + +[base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. + +#### `str`Required + +- *Type:* java.lang.String + +*** + ### `base64gzip` ```java @@ -374,6 +397,28 @@ Fn.chunklist(java.util.List list, java.lang.Number size) *** +### `cidrcontains` + +```java +import io.cdktn.cdktn.Fn; + +Fn.cidrcontains(java.lang.String containing_prefix, java.lang.String contained_ip_or_prefix) +``` + +[cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. + +#### `containing_prefix`Required + +- *Type:* java.lang.String + +*** + +#### `contained_ip_or_prefix`Required + +- *Type:* java.lang.String + +*** + ### `cidrhost` ```java @@ -548,6 +593,28 @@ Fn.contains(java.lang.Object list, java.lang.Object value) *** +### `convert` + +```java +import io.cdktn.cdktn.Fn; + +Fn.convert(java.lang.Object value, java.lang.Object type) +``` + +[convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. + +#### `value`Required + +- *Type:* java.lang.Object + +*** + +#### `type`Required + +- *Type:* java.lang.Object + +*** + ### `csvdecode` ```java @@ -640,6 +707,22 @@ Fn.endswith(java.lang.String str, java.lang.String suffix) *** +### `ephemeralasnull` + +```java +import io.cdktn.cdktn.Fn; + +Fn.ephemeralasnull(java.lang.Object value) +``` + +[ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. + +#### `value`Required + +- *Type:* java.lang.Object + +*** + ### `file` ```java @@ -948,6 +1031,22 @@ Fn.index(java.lang.Object list, java.lang.Object value) *** +### `issensitive` + +```java +import io.cdktn.cdktn.Fn; + +Fn.issensitive(java.lang.Object value) +``` + +[issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. + +#### `value`Required + +- *Type:* java.lang.Object + +*** + ### `jsondecode` ```java @@ -1708,6 +1807,28 @@ Fn.templatefile(java.lang.String path, java.lang.Object vars) *** +### `templatestring` + +```java +import io.cdktn.cdktn.Fn; + +Fn.templatestring(java.lang.String template, java.lang.Object vars) +``` + +[templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. + +#### `template`Required + +- *Type:* java.lang.String + +*** + +#### `vars`Required + +- *Type:* java.lang.Object + +*** + ### `textdecodebase64` ```java @@ -2048,6 +2169,22 @@ Fn.upper(java.lang.String str) *** +### `urldecode` + +```java +import io.cdktn.cdktn.Fn; + +Fn.urldecode(java.lang.String str) +``` + +[urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. + +#### `str`Required + +- *Type:* java.lang.String + +*** + ### `urlencode` ```java diff --git a/content/api-reference/java/classes/lazy-base.mdx b/content/api-reference/java/classes/lazy-base.mdx index b8c3421..0285cb9 100644 --- a/content/api-reference/java/classes/lazy-base.mdx +++ b/content/api-reference/java/classes/lazy-base.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyBase description: CDKTN Core API Reference for LazyBase in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IResolvable diff --git a/content/api-reference/java/classes/lazy.mdx b/content/api-reference/java/classes/lazy.mdx index c0d6be2..a5910bc 100644 --- a/content/api-reference/java/classes/lazy.mdx +++ b/content/api-reference/java/classes/lazy.mdx @@ -4,7 +4,7 @@ sidebarTitle: Lazy description: CDKTN Core API Reference for Lazy in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Lazily produce a value. diff --git a/content/api-reference/java/classes/list-terraform-iterator.mdx b/content/api-reference/java/classes/list-terraform-iterator.mdx index 44f65ba..a15b1f0 100644 --- a/content/api-reference/java/classes/list-terraform-iterator.mdx +++ b/content/api-reference/java/classes/list-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ListTerraformIterator description: CDKTN Core API Reference for ListTerraformIterator in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/manifest.mdx b/content/api-reference/java/classes/manifest.mdx index 6ca1cf8..8f3a0e3 100644 --- a/content/api-reference/java/classes/manifest.mdx +++ b/content/api-reference/java/classes/manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: Manifest description: CDKTN Core API Reference for Manifest in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IManifest diff --git a/content/api-reference/java/classes/map-list.mdx b/content/api-reference/java/classes/map-list.mdx index b876764..2f1e363 100644 --- a/content/api-reference/java/classes/map-list.mdx +++ b/content/api-reference/java/classes/map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: MapList description: CDKTN Core API Reference for MapList in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IInterpolatingParent, IResolvable diff --git a/content/api-reference/java/classes/map-terraform-iterator.mdx b/content/api-reference/java/classes/map-terraform-iterator.mdx index deccbcc..81b7ddc 100644 --- a/content/api-reference/java/classes/map-terraform-iterator.mdx +++ b/content/api-reference/java/classes/map-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: MapTerraformIterator description: CDKTN Core API Reference for MapTerraformIterator in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/migrate-ids.mdx b/content/api-reference/java/classes/migrate-ids.mdx index b177a6c..81ec853 100644 --- a/content/api-reference/java/classes/migrate-ids.mdx +++ b/content/api-reference/java/classes/migrate-ids.mdx @@ -4,7 +4,7 @@ sidebarTitle: MigrateIds description: CDKTN Core API Reference for MigrateIds in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IAspect diff --git a/content/api-reference/java/classes/named-cloud-workspace.mdx b/content/api-reference/java/classes/named-cloud-workspace.mdx index aaf651e..f6a5c78 100644 --- a/content/api-reference/java/classes/named-cloud-workspace.mdx +++ b/content/api-reference/java/classes/named-cloud-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: NamedCloudWorkspace description: CDKTN Core API Reference for NamedCloudWorkspace in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The name of a single Terraform Cloud workspace. diff --git a/content/api-reference/java/classes/named-remote-workspace.mdx b/content/api-reference/java/classes/named-remote-workspace.mdx index 095860c..a31d5d8 100644 --- a/content/api-reference/java/classes/named-remote-workspace.mdx +++ b/content/api-reference/java/classes/named-remote-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: NamedRemoteWorkspace description: CDKTN Core API Reference for NamedRemoteWorkspace in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IRemoteWorkspace diff --git a/content/api-reference/java/classes/number-list-list.mdx b/content/api-reference/java/classes/number-list-list.mdx index ffc9caa..04e119b 100644 --- a/content/api-reference/java/classes/number-list-list.mdx +++ b/content/api-reference/java/classes/number-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberListList description: CDKTN Core API Reference for NumberListList in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/number-list-map.mdx b/content/api-reference/java/classes/number-list-map.mdx index 24a008f..8f10700 100644 --- a/content/api-reference/java/classes/number-list-map.mdx +++ b/content/api-reference/java/classes/number-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberListMap description: CDKTN Core API Reference for NumberListMap in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/number-map-list.mdx b/content/api-reference/java/classes/number-map-list.mdx index c5d58f4..a008049 100644 --- a/content/api-reference/java/classes/number-map-list.mdx +++ b/content/api-reference/java/classes/number-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberMapList description: CDKTN Core API Reference for NumberMapList in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/number-map.mdx b/content/api-reference/java/classes/number-map.mdx index 21721b5..7f0ebd4 100644 --- a/content/api-reference/java/classes/number-map.mdx +++ b/content/api-reference/java/classes/number-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberMap description: CDKTN Core API Reference for NumberMap in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/java/classes/op.mdx b/content/api-reference/java/classes/op.mdx index e839bdf..0248c51 100644 --- a/content/api-reference/java/classes/op.mdx +++ b/content/api-reference/java/classes/op.mdx @@ -4,7 +4,7 @@ sidebarTitle: Op description: CDKTN Core API Reference for Op in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} This class contains static functions for all arithmetical and logical operators in the Terraform configuration language. diff --git a/content/api-reference/java/classes/prefixed-remote-workspaces.mdx b/content/api-reference/java/classes/prefixed-remote-workspaces.mdx index e8b14af..299f18c 100644 --- a/content/api-reference/java/classes/prefixed-remote-workspaces.mdx +++ b/content/api-reference/java/classes/prefixed-remote-workspaces.mdx @@ -4,7 +4,7 @@ sidebarTitle: PrefixedRemoteWorkspaces description: CDKTN Core API Reference for PrefixedRemoteWorkspaces in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IRemoteWorkspace diff --git a/content/api-reference/java/classes/resource-terraform-iterator.mdx b/content/api-reference/java/classes/resource-terraform-iterator.mdx index 70edb96..faceaaf 100644 --- a/content/api-reference/java/classes/resource-terraform-iterator.mdx +++ b/content/api-reference/java/classes/resource-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ResourceTerraformIterator description: CDKTN Core API Reference for ResourceTerraformIterator in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/string-concat.mdx b/content/api-reference/java/classes/string-concat.mdx index 1d5ea40..6f4ae4b 100644 --- a/content/api-reference/java/classes/string-concat.mdx +++ b/content/api-reference/java/classes/string-concat.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringConcat description: CDKTN Core API Reference for StringConcat in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IFragmentConcatenator diff --git a/content/api-reference/java/classes/string-list-list.mdx b/content/api-reference/java/classes/string-list-list.mdx index 3d3332f..89b49cb 100644 --- a/content/api-reference/java/classes/string-list-list.mdx +++ b/content/api-reference/java/classes/string-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringListList description: CDKTN Core API Reference for StringListList in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/string-list-map.mdx b/content/api-reference/java/classes/string-list-map.mdx index 05b1996..ba3ff30 100644 --- a/content/api-reference/java/classes/string-list-map.mdx +++ b/content/api-reference/java/classes/string-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringListMap description: CDKTN Core API Reference for StringListMap in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/string-map-list.mdx b/content/api-reference/java/classes/string-map-list.mdx index d815451..d751dd1 100644 --- a/content/api-reference/java/classes/string-map-list.mdx +++ b/content/api-reference/java/classes/string-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMapList description: CDKTN Core API Reference for StringMapList in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/string-map-map.mdx b/content/api-reference/java/classes/string-map-map.mdx index f5b5038..7c1c539 100644 --- a/content/api-reference/java/classes/string-map-map.mdx +++ b/content/api-reference/java/classes/string-map-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMapMap description: CDKTN Core API Reference for StringMapMap in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/java/classes/string-map.mdx b/content/api-reference/java/classes/string-map.mdx index 182de05..0681593 100644 --- a/content/api-reference/java/classes/string-map.mdx +++ b/content/api-reference/java/classes/string-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMap description: CDKTN Core API Reference for StringMap in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/java/classes/tagged-cloud-workspaces.mdx b/content/api-reference/java/classes/tagged-cloud-workspaces.mdx index 731ef5a..b2e5eca 100644 --- a/content/api-reference/java/classes/tagged-cloud-workspaces.mdx +++ b/content/api-reference/java/classes/tagged-cloud-workspaces.mdx @@ -4,7 +4,7 @@ sidebarTitle: TaggedCloudWorkspaces description: CDKTN Core API Reference for TaggedCloudWorkspaces in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} A set of Terraform Cloud workspace tags. diff --git a/content/api-reference/java/classes/terraform-count.mdx b/content/api-reference/java/classes/terraform-count.mdx index aa104d5..4ffe248 100644 --- a/content/api-reference/java/classes/terraform-count.mdx +++ b/content/api-reference/java/classes/terraform-count.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformCount description: CDKTN Core API Reference for TerraformCount in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Iterator for the Terraform count property. diff --git a/content/api-reference/java/classes/terraform-iterator.mdx b/content/api-reference/java/classes/terraform-iterator.mdx index 7ff8efb..646af1d 100644 --- a/content/api-reference/java/classes/terraform-iterator.mdx +++ b/content/api-reference/java/classes/terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformIterator description: CDKTN Core API Reference for TerraformIterator in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformIterator diff --git a/content/api-reference/java/classes/terraform-resource-targets.mdx b/content/api-reference/java/classes/terraform-resource-targets.mdx index 9ea341e..f30fca3 100644 --- a/content/api-reference/java/classes/terraform-resource-targets.mdx +++ b/content/api-reference/java/classes/terraform-resource-targets.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceTargets description: CDKTN Core API Reference for TerraformResourceTargets in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/classes/terraform-self.mdx b/content/api-reference/java/classes/terraform-self.mdx index 8872a0c..df2757c 100644 --- a/content/api-reference/java/classes/terraform-self.mdx +++ b/content/api-reference/java/classes/terraform-self.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformSelf description: CDKTN Core API Reference for TerraformSelf in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Expressions in connection blocks cannot refer to their parent resource by name. diff --git a/content/api-reference/java/classes/testing.mdx b/content/api-reference/java/classes/testing.mdx index a6661b7..f25d093 100644 --- a/content/api-reference/java/classes/testing.mdx +++ b/content/api-reference/java/classes/testing.mdx @@ -4,7 +4,7 @@ sidebarTitle: Testing description: CDKTN Core API Reference for Testing in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Testing utilities for cdktf applications. diff --git a/content/api-reference/java/classes/token.mdx b/content/api-reference/java/classes/token.mdx index 4d83c89..bf94281 100644 --- a/content/api-reference/java/classes/token.mdx +++ b/content/api-reference/java/classes/token.mdx @@ -4,7 +4,7 @@ sidebarTitle: Token description: CDKTN Core API Reference for Token in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Represents a special or lazily-evaluated value. diff --git a/content/api-reference/java/classes/tokenization.mdx b/content/api-reference/java/classes/tokenization.mdx index 69a840a..36e34ab 100644 --- a/content/api-reference/java/classes/tokenization.mdx +++ b/content/api-reference/java/classes/tokenization.mdx @@ -4,7 +4,7 @@ sidebarTitle: Tokenization description: CDKTN Core API Reference for Tokenization in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Less oft-needed functions to manipulate Tokens. diff --git a/content/api-reference/java/classes/tokenized-string-fragments.mdx b/content/api-reference/java/classes/tokenized-string-fragments.mdx index a4227aa..72e9988 100644 --- a/content/api-reference/java/classes/tokenized-string-fragments.mdx +++ b/content/api-reference/java/classes/tokenized-string-fragments.mdx @@ -4,7 +4,7 @@ sidebarTitle: TokenizedStringFragments description: CDKTN Core API Reference for TokenizedStringFragments in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Fragments of a concatenated string containing stringified Tokens. diff --git a/content/api-reference/java/classes/variable-type.mdx b/content/api-reference/java/classes/variable-type.mdx index 97e8599..b854c80 100644 --- a/content/api-reference/java/classes/variable-type.mdx +++ b/content/api-reference/java/classes/variable-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: VariableType description: CDKTN Core API Reference for VariableType in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/java/constructs/app.mdx b/content/api-reference/java/constructs/app.mdx index e129c4f..f82db23 100644 --- a/content/api-reference/java/constructs/app.mdx +++ b/content/api-reference/java/constructs/app.mdx @@ -4,7 +4,7 @@ sidebarTitle: App description: CDKTN Core API Reference for App in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Represents a cdktn application. @@ -101,6 +101,7 @@ Whether to skip all validations during synthesis of the app. | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | crossStackReference | Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources. | | synth | Synthesizes all resources to the output directory. | @@ -114,6 +115,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `crossStackReference` ```java diff --git a/content/api-reference/java/constructs/azurerm-backend.mdx b/content/api-reference/java/constructs/azurerm-backend.mdx index 06bda98..9dfa689 100644 --- a/content/api-reference/java/constructs/azurerm-backend.mdx +++ b/content/api-reference/java/constructs/azurerm-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: AzurermBackend description: CDKTN Core API Reference for AzurermBackend in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -340,6 +340,7 @@ must be set to true (which is the default). | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -358,6 +359,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/cloud-backend.mdx b/content/api-reference/java/constructs/cloud-backend.mdx index 24ea22a..9be92ab 100644 --- a/content/api-reference/java/constructs/cloud-backend.mdx +++ b/content/api-reference/java/constructs/cloud-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudBackend description: CDKTN Core API Reference for CloudBackend in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The Cloud Backend synthesizes a [cloud block](https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block). The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings. @@ -79,6 +79,7 @@ We recommend omitting the token from the configuration, and instead using terraf | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -97,6 +98,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/consul-backend.mdx b/content/api-reference/java/constructs/consul-backend.mdx index b27fc14..9e69c2f 100644 --- a/content/api-reference/java/constructs/consul-backend.mdx +++ b/content/api-reference/java/constructs/consul-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: ConsulBackend description: CDKTN Core API Reference for ConsulBackend in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -153,6 +153,7 @@ SSL support can also be triggered by setting then environment variable CONSUL\_H | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -171,6 +172,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/cos-backend.mdx b/content/api-reference/java/constructs/cos-backend.mdx index f95f70f..bd80f51 100644 --- a/content/api-reference/java/constructs/cos-backend.mdx +++ b/content/api-reference/java/constructs/cos-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackend description: CDKTN Core API Reference for CosBackend in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -189,6 +189,7 @@ It supports environment variables TENCENTCLOUD\_SECURITY\_TOKEN. | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -207,6 +208,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/data-resource.mdx b/content/api-reference/java/constructs/data-resource.mdx index c8f9cfd..3288fb8 100644 --- a/content/api-reference/java/constructs/data-resource.mdx +++ b/content/api-reference/java/constructs/data-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataResource description: CDKTN Core API Reference for DataResource in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The DataResource implements the standard resource lifecycle, but does not directly take any other actions. @@ -137,6 +137,7 @@ https://developer.hashicorp.com/terraform/language/resources/terraform-data#trig | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -172,6 +173,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/data-terraform-remote-state-azurerm.mdx b/content/api-reference/java/constructs/data-terraform-remote-state-azurerm.mdx index e1549b3..29369fa 100644 --- a/content/api-reference/java/constructs/data-terraform-remote-state-azurerm.mdx +++ b/content/api-reference/java/constructs/data-terraform-remote-state-azurerm.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateAzurerm description: CDKTN Core API Reference for DataTerraformRemoteStateAzurerm in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -363,6 +363,7 @@ must be set to true (which is the default). | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -385,6 +386,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/data-terraform-remote-state-consul.mdx b/content/api-reference/java/constructs/data-terraform-remote-state-consul.mdx index b39b4f6..591428d 100644 --- a/content/api-reference/java/constructs/data-terraform-remote-state-consul.mdx +++ b/content/api-reference/java/constructs/data-terraform-remote-state-consul.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConsul description: CDKTN Core API Reference for DataTerraformRemoteStateConsul in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -176,6 +176,7 @@ SSL support can also be triggered by setting then environment variable CONSUL\_H | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -198,6 +199,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/data-terraform-remote-state-cos.mdx b/content/api-reference/java/constructs/data-terraform-remote-state-cos.mdx index 4c66722..938ef54 100644 --- a/content/api-reference/java/constructs/data-terraform-remote-state-cos.mdx +++ b/content/api-reference/java/constructs/data-terraform-remote-state-cos.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateCos description: CDKTN Core API Reference for DataTerraformRemoteStateCos in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -212,6 +212,7 @@ It supports environment variables TENCENTCLOUD\_SECURITY\_TOKEN. | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -234,6 +235,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/data-terraform-remote-state-gcs.mdx b/content/api-reference/java/constructs/data-terraform-remote-state-gcs.mdx index 53f6d52..8b76661 100644 --- a/content/api-reference/java/constructs/data-terraform-remote-state-gcs.mdx +++ b/content/api-reference/java/constructs/data-terraform-remote-state-gcs.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateGcs description: CDKTN Core API Reference for DataTerraformRemoteStateGcs in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -164,6 +164,7 @@ Named states for workspaces are stored in an object called < prefix >/< na | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -186,6 +187,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/data-terraform-remote-state-http.mdx b/content/api-reference/java/constructs/data-terraform-remote-state-http.mdx index 5db6332..289ee6d 100644 --- a/content/api-reference/java/constructs/data-terraform-remote-state-http.mdx +++ b/content/api-reference/java/constructs/data-terraform-remote-state-http.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateHttp description: CDKTN Core API Reference for DataTerraformRemoteStateHttp in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -223,6 +223,7 @@ Defaults to POST. | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -245,6 +246,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/data-terraform-remote-state-local.mdx b/content/api-reference/java/constructs/data-terraform-remote-state-local.mdx index a329e5e..ae5e82b 100644 --- a/content/api-reference/java/constructs/data-terraform-remote-state-local.mdx +++ b/content/api-reference/java/constructs/data-terraform-remote-state-local.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateLocal description: CDKTN Core API Reference for DataTerraformRemoteStateLocal in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -76,6 +76,7 @@ Path where the state file is stored. | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -98,6 +99,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/data-terraform-remote-state-oss.mdx b/content/api-reference/java/constructs/data-terraform-remote-state-oss.mdx index e6dc716..a7598f1 100644 --- a/content/api-reference/java/constructs/data-terraform-remote-state-oss.mdx +++ b/content/api-reference/java/constructs/data-terraform-remote-state-oss.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateOss description: CDKTN Core API Reference for DataTerraformRemoteStateOss in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -283,6 +283,7 @@ The table must have a primary key named LockID of type String. | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -305,6 +306,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/data-terraform-remote-state-pg.mdx b/content/api-reference/java/constructs/data-terraform-remote-state-pg.mdx index 3dfc4f8..37c236e 100644 --- a/content/api-reference/java/constructs/data-terraform-remote-state-pg.mdx +++ b/content/api-reference/java/constructs/data-terraform-remote-state-pg.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStatePg description: CDKTN Core API Reference for DataTerraformRemoteStatePg in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -119,6 +119,7 @@ Terraform won't try to create the table, this is useful when it has already been | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -141,6 +142,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/data-terraform-remote-state-s3.mdx b/content/api-reference/java/constructs/data-terraform-remote-state-s3.mdx index 80dbe2e..ce8a1e7 100644 --- a/content/api-reference/java/constructs/data-terraform-remote-state-s3.mdx +++ b/content/api-reference/java/constructs/data-terraform-remote-state-s3.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateS3 description: CDKTN Core API Reference for DataTerraformRemoteStateS3 in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -62,6 +62,7 @@ DataTerraformRemoteStateS3.Builder.create(Construct scope, java.lang.String id) // .stsRegion(java.lang.String) // .token(java.lang.String) // .useLegacyWorkflow(java.lang.Boolean) +// .useLockfile(java.lang.Boolean) // .usePathStyle(java.lang.Boolean) // .workspaceKeyPrefix(java.lang.String) .build(); @@ -121,6 +122,7 @@ DataTerraformRemoteStateS3.Builder.create(Construct scope, java.lang.String id) | stsRegion | java.lang.String | (Optional) AWS region for STS. | | token | java.lang.String | (Optional) Multi-Factor Authentication (MFA) token. | | useLegacyWorkflow | java.lang.Boolean | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. | +| useLockfile | java.lang.Boolean | (Optional) Whether to use a lockfile for locking the state file. | | usePathStyle | java.lang.Boolean | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). | | workspaceKeyPrefix | java.lang.String | (Optional) Prefix applied to the state path inside the bucket. | @@ -281,7 +283,9 @@ This can also be sourced from the AWS\_DYNAMODB\_ENDPOINT environment variable. *** -### `dynamodbTable`Optional +### ~~`dynamodbTable`~~Optional + +- *Deprecated:* Use useLockfile instead, which uses S3 for locking - *Type:* java.lang.String @@ -645,6 +649,21 @@ This behavior does not align with the authentication flow of the AWS CLI or SDK' *** +### `useLockfile`Optional + +- *Type:* java.lang.Boolean + +(Optional) Whether to use a lockfile for locking the state file. + +Defaults to false. +State locking is an opt-in feature of the S3 backend. +Locking can be enabled via S3 or DynamoDB (see dynamodbTable). However, DynamoDB-based locking +is deprecated and will be removed in a future minor version. To support migration from older +versions of Terraform that only support DynamoDB-based locking, the S3 (useLockfile) and DynamoDB +(dynamodbTable) arguments can be configured simultaneously. + +*** + ### `usePathStyle`Optional - *Type:* java.lang.Boolean @@ -668,6 +687,7 @@ This is only relevant when using a non-default workspace. Defaults to env: | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -690,6 +710,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/data-terraform-remote-state-swift.mdx b/content/api-reference/java/constructs/data-terraform-remote-state-swift.mdx index 9068ed1..bef3eba 100644 --- a/content/api-reference/java/constructs/data-terraform-remote-state-swift.mdx +++ b/content/api-reference/java/constructs/data-terraform-remote-state-swift.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateSwift description: CDKTN Core API Reference for DataTerraformRemoteStateSwift in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -329,6 +329,7 @@ DataTerraformRemoteStateSwift.Builder.create(Construct scope, java.lang.String i | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -351,6 +352,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### ~~`with`~~ + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### ~~`addOverride`~~ ```java diff --git a/content/api-reference/java/constructs/data-terraform-remote-state.mdx b/content/api-reference/java/constructs/data-terraform-remote-state.mdx index fef0431..18b82d7 100644 --- a/content/api-reference/java/constructs/data-terraform-remote-state.mdx +++ b/content/api-reference/java/constructs/data-terraform-remote-state.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteState description: CDKTN Core API Reference for DataTerraformRemoteState in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -87,6 +87,7 @@ DataTerraformRemoteState.Builder.create(Construct scope, java.lang.String id) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -109,6 +110,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/gcs-backend.mdx b/content/api-reference/java/constructs/gcs-backend.mdx index 802b538..389a540 100644 --- a/content/api-reference/java/constructs/gcs-backend.mdx +++ b/content/api-reference/java/constructs/gcs-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: GcsBackend description: CDKTN Core API Reference for GcsBackend in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -141,6 +141,7 @@ Named states for workspaces are stored in an object called < prefix >/< na | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -159,6 +160,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/http-backend.mdx b/content/api-reference/java/constructs/http-backend.mdx index 7a7ff29..ee0d508 100644 --- a/content/api-reference/java/constructs/http-backend.mdx +++ b/content/api-reference/java/constructs/http-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: HttpBackend description: CDKTN Core API Reference for HttpBackend in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -200,6 +200,7 @@ Defaults to POST. | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -218,6 +219,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/importable-resource.mdx b/content/api-reference/java/constructs/importable-resource.mdx index be6383a..de4a603 100644 --- a/content/api-reference/java/constructs/importable-resource.mdx +++ b/content/api-reference/java/constructs/importable-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: ImportableResource description: CDKTN Core API Reference for ImportableResource in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Class used to represent an importable resource. @@ -47,6 +47,7 @@ new ImportableResource(Construct scope, java.lang.String name, IImportableConfig | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -64,6 +65,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/local-backend.mdx b/content/api-reference/java/constructs/local-backend.mdx index 91ba924..062c655 100644 --- a/content/api-reference/java/constructs/local-backend.mdx +++ b/content/api-reference/java/constructs/local-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalBackend description: CDKTN Core API Reference for LocalBackend in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -53,6 +53,7 @@ Path where the state file is stored. | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -71,6 +72,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/oss-backend.mdx b/content/api-reference/java/constructs/oss-backend.mdx index e48b5f7..42c1e47 100644 --- a/content/api-reference/java/constructs/oss-backend.mdx +++ b/content/api-reference/java/constructs/oss-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssBackend description: CDKTN Core API Reference for OssBackend in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -260,6 +260,7 @@ The table must have a primary key named LockID of type String. | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -278,6 +279,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/pg-backend.mdx b/content/api-reference/java/constructs/pg-backend.mdx index 9f5990a..3fcaca4 100644 --- a/content/api-reference/java/constructs/pg-backend.mdx +++ b/content/api-reference/java/constructs/pg-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: PgBackend description: CDKTN Core API Reference for PgBackend in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -96,6 +96,7 @@ Terraform won't try to create the table, this is useful when it has already been | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -114,6 +115,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/remote-backend.mdx b/content/api-reference/java/constructs/remote-backend.mdx index 0367afc..a831bf7 100644 --- a/content/api-reference/java/constructs/remote-backend.mdx +++ b/content/api-reference/java/constructs/remote-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteBackend description: CDKTN Core API Reference for RemoteBackend in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -64,6 +64,7 @@ RemoteBackend.Builder.create(Construct scope) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -82,6 +83,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/resource.mdx b/content/api-reference/java/constructs/resource.mdx index f581912..9c8fc23 100644 --- a/content/api-reference/java/constructs/resource.mdx +++ b/content/api-reference/java/constructs/resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: Resource description: CDKTN Core API Reference for Resource in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IResource @@ -42,6 +42,7 @@ new Resource(Construct scope, java.lang.String id); | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | *** @@ -53,6 +54,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### ~~`with`~~ + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ## Static Functions | **Name** | **Description** | diff --git a/content/api-reference/java/constructs/s3-backend.mdx b/content/api-reference/java/constructs/s3-backend.mdx index 912320a..ecf1bf1 100644 --- a/content/api-reference/java/constructs/s3-backend.mdx +++ b/content/api-reference/java/constructs/s3-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3Backend description: CDKTN Core API Reference for S3Backend in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -60,6 +60,7 @@ S3Backend.Builder.create(Construct scope) // .stsRegion(java.lang.String) // .token(java.lang.String) // .useLegacyWorkflow(java.lang.Boolean) +// .useLockfile(java.lang.Boolean) // .usePathStyle(java.lang.Boolean) // .workspaceKeyPrefix(java.lang.String) .build(); @@ -116,6 +117,7 @@ S3Backend.Builder.create(Construct scope) | stsRegion | java.lang.String | (Optional) AWS region for STS. | | token | java.lang.String | (Optional) Multi-Factor Authentication (MFA) token. | | useLegacyWorkflow | java.lang.Boolean | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. | +| useLockfile | java.lang.Boolean | (Optional) Whether to use a lockfile for locking the state file. | | usePathStyle | java.lang.Boolean | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). | | workspaceKeyPrefix | java.lang.String | (Optional) Prefix applied to the state path inside the bucket. | @@ -258,7 +260,9 @@ This can also be sourced from the AWS\_DYNAMODB\_ENDPOINT environment variable. *** -### `dynamodbTable`Optional +### ~~`dynamodbTable`~~Optional + +- *Deprecated:* Use useLockfile instead, which uses S3 for locking - *Type:* java.lang.String @@ -622,6 +626,21 @@ This behavior does not align with the authentication flow of the AWS CLI or SDK' *** +### `useLockfile`Optional + +- *Type:* java.lang.Boolean + +(Optional) Whether to use a lockfile for locking the state file. + +Defaults to false. +State locking is an opt-in feature of the S3 backend. +Locking can be enabled via S3 or DynamoDB (see dynamodbTable). However, DynamoDB-based locking +is deprecated and will be removed in a future minor version. To support migration from older +versions of Terraform that only support DynamoDB-based locking, the S3 (useLockfile) and DynamoDB +(dynamodbTable) arguments can be configured simultaneously. + +*** + ### `usePathStyle`Optional - *Type:* java.lang.Boolean @@ -645,6 +664,7 @@ This is only relevant when using a non-default workspace. Defaults to env: | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -663,6 +683,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/swift-backend.mdx b/content/api-reference/java/constructs/swift-backend.mdx index 038cac2..b3742d8 100644 --- a/content/api-reference/java/constructs/swift-backend.mdx +++ b/content/api-reference/java/constructs/swift-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: SwiftBackend description: CDKTN Core API Reference for SwiftBackend in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -302,6 +302,7 @@ SwiftBackend.Builder.create(Construct scope) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -320,6 +321,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### ~~`with`~~ + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### ~~`addOverride`~~ ```java diff --git a/content/api-reference/java/constructs/terraform-asset.mdx b/content/api-reference/java/constructs/terraform-asset.mdx index 67c0950..f612e4d 100644 --- a/content/api-reference/java/constructs/terraform-asset.mdx +++ b/content/api-reference/java/constructs/terraform-asset.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformAsset description: CDKTN Core API Reference for TerraformAsset in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -63,6 +63,7 @@ TerraformAsset.Builder.create(Construct scope, java.lang.String id) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | *** @@ -74,6 +75,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ## Static Functions | **Name** | **Description** | diff --git a/content/api-reference/java/constructs/terraform-backend.mdx b/content/api-reference/java/constructs/terraform-backend.mdx index cc141a0..10a62f4 100644 --- a/content/api-reference/java/constructs/terraform-backend.mdx +++ b/content/api-reference/java/constructs/terraform-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformBackend description: CDKTN Core API Reference for TerraformBackend in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new TerraformBackend(Construct scope, java.lang.String id, java.lang.String name | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -63,6 +64,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/terraform-data-source.mdx b/content/api-reference/java/constructs/terraform-data-source.mdx index 1289f69..3a4e990 100644 --- a/content/api-reference/java/constructs/terraform-data-source.mdx +++ b/content/api-reference/java/constructs/terraform-data-source.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformDataSource description: CDKTN Core API Reference for TerraformDataSource in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformResource, ITerraformDependable, IInterpolatingParent @@ -113,6 +113,7 @@ TerraformDataSource.Builder.create(Construct scope, java.lang.String id) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -140,6 +141,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/terraform-element.mdx b/content/api-reference/java/constructs/terraform-element.mdx index 882d036..2d76857 100644 --- a/content/api-reference/java/constructs/terraform-element.mdx +++ b/content/api-reference/java/constructs/terraform-element.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformElement description: CDKTN Core API Reference for TerraformElement in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new TerraformElement(Construct scope, java.lang.String id);,new TerraformElement | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -62,6 +63,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/terraform-hcl-module.mdx b/content/api-reference/java/constructs/terraform-hcl-module.mdx index 1392f73..aafb153 100644 --- a/content/api-reference/java/constructs/terraform-hcl-module.mdx +++ b/content/api-reference/java/constructs/terraform-hcl-module.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformHclModule description: CDKTN Core API Reference for TerraformHclModule in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -95,6 +95,7 @@ TerraformHclModule.Builder.create(Construct scope, java.lang.String id) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -120,6 +121,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/terraform-local.mdx b/content/api-reference/java/constructs/terraform-local.mdx index fb767e7..2fbac09 100644 --- a/content/api-reference/java/constructs/terraform-local.mdx +++ b/content/api-reference/java/constructs/terraform-local.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformLocal description: CDKTN Core API Reference for TerraformLocal in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -47,6 +47,7 @@ new TerraformLocal(Construct scope, java.lang.String id, java.lang.Object expres | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -64,6 +65,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/terraform-module.mdx b/content/api-reference/java/constructs/terraform-module.mdx index 0ac3f5f..3971aaa 100644 --- a/content/api-reference/java/constructs/terraform-module.mdx +++ b/content/api-reference/java/constructs/terraform-module.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModule description: CDKTN Core API Reference for TerraformModule in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformDependable @@ -98,6 +98,7 @@ TerraformModule.Builder.create(Construct scope, java.lang.String id) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -118,6 +119,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/terraform-output.mdx b/content/api-reference/java/constructs/terraform-output.mdx index 131ebf2..1f3bcf5 100644 --- a/content/api-reference/java/constructs/terraform-output.mdx +++ b/content/api-reference/java/constructs/terraform-output.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformOutput description: CDKTN Core API Reference for TerraformOutput in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -90,6 +90,7 @@ If set to true the synthesized Terraform Output will be named after the `id` pas | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -107,6 +108,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/terraform-provider.mdx b/content/api-reference/java/constructs/terraform-provider.mdx index c684638..7e12e74 100644 --- a/content/api-reference/java/constructs/terraform-provider.mdx +++ b/content/api-reference/java/constructs/terraform-provider.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProvider description: CDKTN Core API Reference for TerraformProvider in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -63,6 +63,7 @@ TerraformProvider.Builder.create(Construct scope, java.lang.String id) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -80,6 +81,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/terraform-remote-state.mdx b/content/api-reference/java/constructs/terraform-remote-state.mdx index 240c497..cbf5447 100644 --- a/content/api-reference/java/constructs/terraform-remote-state.mdx +++ b/content/api-reference/java/constructs/terraform-remote-state.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformRemoteState description: CDKTN Core API Reference for TerraformRemoteState in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -64,6 +64,7 @@ TerraformRemoteState.Builder.create(Construct scope, java.lang.String id, java.l | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -86,6 +87,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/terraform-resource.mdx b/content/api-reference/java/constructs/terraform-resource.mdx index 80a9be9..3c68585 100644 --- a/content/api-reference/java/constructs/terraform-resource.mdx +++ b/content/api-reference/java/constructs/terraform-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResource description: CDKTN Core API Reference for TerraformResource in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformResource, ITerraformDependable, IInterpolatingParent @@ -113,6 +113,7 @@ TerraformResource.Builder.create(Construct scope, java.lang.String id) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -146,6 +147,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/constructs/terraform-stack.mdx b/content/api-reference/java/constructs/terraform-stack.mdx index 81b6068..40c72ad 100644 --- a/content/api-reference/java/constructs/terraform-stack.mdx +++ b/content/api-reference/java/constructs/terraform-stack.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformStack description: CDKTN Core API Reference for TerraformStack in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new TerraformStack(Construct scope, java.lang.String id); | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addDependency | *No description.* | | addOverride | *No description.* | | allProviders | *No description.* | @@ -62,6 +63,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addDependency` ```java diff --git a/content/api-reference/java/constructs/terraform-variable.mdx b/content/api-reference/java/constructs/terraform-variable.mdx index bf0a2ca..ca59918 100644 --- a/content/api-reference/java/constructs/terraform-variable.mdx +++ b/content/api-reference/java/constructs/terraform-variable.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariable description: CDKTN Core API Reference for TerraformVariable in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -115,6 +115,7 @@ Specify arbitrary custom validation rules for a particular variable using a vali | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -135,6 +136,27 @@ public java.lang.String toString() Returns a string representation of this construct. +### `with` + +```java +public IConstruct with(IMixin... mixins) +``` + +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. + +#### `mixins`Required + +- *Type:* software.constructs.IMixin... + +The mixins to apply. + +*** + ### `addOverride` ```java diff --git a/content/api-reference/java/enums/annotation-metadata-entry-type.mdx b/content/api-reference/java/enums/annotation-metadata-entry-type.mdx index 7057d39..901f86f 100644 --- a/content/api-reference/java/enums/annotation-metadata-entry-type.mdx +++ b/content/api-reference/java/enums/annotation-metadata-entry-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnnotationMetadataEntryType description: CDKTN Core API Reference for AnnotationMetadataEntryType in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Members diff --git a/content/api-reference/java/enums/asset-type.mdx b/content/api-reference/java/enums/asset-type.mdx index 2f9846b..0599825 100644 --- a/content/api-reference/java/enums/asset-type.mdx +++ b/content/api-reference/java/enums/asset-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: AssetType description: CDKTN Core API Reference for AssetType in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Members diff --git a/content/api-reference/java/protocols/i-any-producer.mdx b/content/api-reference/java/protocols/i-any-producer.mdx index 220a030..b5399fc 100644 --- a/content/api-reference/java/protocols/i-any-producer.mdx +++ b/content/api-reference/java/protocols/i-any-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IAnyProducer description: CDKTN Core API Reference for IAnyProducer in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IAnyProducer diff --git a/content/api-reference/java/protocols/i-aspect.mdx b/content/api-reference/java/protocols/i-aspect.mdx index f709689..b7e1637 100644 --- a/content/api-reference/java/protocols/i-aspect.mdx +++ b/content/api-reference/java/protocols/i-aspect.mdx @@ -4,7 +4,7 @@ sidebarTitle: IAspect description: CDKTN Core API Reference for IAspect in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* MigrateIds, IAspect diff --git a/content/api-reference/java/protocols/i-fragment-concatenator.mdx b/content/api-reference/java/protocols/i-fragment-concatenator.mdx index 544242f..c6cb7e2 100644 --- a/content/api-reference/java/protocols/i-fragment-concatenator.mdx +++ b/content/api-reference/java/protocols/i-fragment-concatenator.mdx @@ -4,7 +4,7 @@ sidebarTitle: IFragmentConcatenator description: CDKTN Core API Reference for IFragmentConcatenator in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* StringConcat, IFragmentConcatenator diff --git a/content/api-reference/java/protocols/i-importable-config.mdx b/content/api-reference/java/protocols/i-importable-config.mdx index a123891..cfb2c89 100644 --- a/content/api-reference/java/protocols/i-importable-config.mdx +++ b/content/api-reference/java/protocols/i-importable-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: IImportableConfig description: CDKTN Core API Reference for IImportableConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IImportableConfig diff --git a/content/api-reference/java/protocols/i-interpolating-parent.mdx b/content/api-reference/java/protocols/i-interpolating-parent.mdx index 14deec8..39af145 100644 --- a/content/api-reference/java/protocols/i-interpolating-parent.mdx +++ b/content/api-reference/java/protocols/i-interpolating-parent.mdx @@ -4,7 +4,7 @@ sidebarTitle: IInterpolatingParent description: CDKTN Core API Reference for IInterpolatingParent in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyMapList, BooleanMapList, ComplexComputedList, ComplexObject, DataResource, MapList, NumberMapList, StringMapList, TerraformDataSource, TerraformResource, IInterpolatingParent diff --git a/content/api-reference/java/protocols/i-list-producer.mdx b/content/api-reference/java/protocols/i-list-producer.mdx index 9431829..839e24c 100644 --- a/content/api-reference/java/protocols/i-list-producer.mdx +++ b/content/api-reference/java/protocols/i-list-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IListProducer description: CDKTN Core API Reference for IListProducer in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IListProducer diff --git a/content/api-reference/java/protocols/i-manifest.mdx b/content/api-reference/java/protocols/i-manifest.mdx index 1519b29..e08517c 100644 --- a/content/api-reference/java/protocols/i-manifest.mdx +++ b/content/api-reference/java/protocols/i-manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: IManifest description: CDKTN Core API Reference for IManifest in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* Manifest, IManifest diff --git a/content/api-reference/java/protocols/i-number-producer.mdx b/content/api-reference/java/protocols/i-number-producer.mdx index 713f702..f26ee70 100644 --- a/content/api-reference/java/protocols/i-number-producer.mdx +++ b/content/api-reference/java/protocols/i-number-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: INumberProducer description: CDKTN Core API Reference for INumberProducer in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* INumberProducer diff --git a/content/api-reference/java/protocols/i-post-processor.mdx b/content/api-reference/java/protocols/i-post-processor.mdx index 3641e80..ee679df 100644 --- a/content/api-reference/java/protocols/i-post-processor.mdx +++ b/content/api-reference/java/protocols/i-post-processor.mdx @@ -4,7 +4,7 @@ sidebarTitle: IPostProcessor description: CDKTN Core API Reference for IPostProcessor in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IPostProcessor diff --git a/content/api-reference/java/protocols/i-remote-workspace.mdx b/content/api-reference/java/protocols/i-remote-workspace.mdx index 85ecfa3..2c4a7c3 100644 --- a/content/api-reference/java/protocols/i-remote-workspace.mdx +++ b/content/api-reference/java/protocols/i-remote-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: IRemoteWorkspace description: CDKTN Core API Reference for IRemoteWorkspace in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* NamedRemoteWorkspace, PrefixedRemoteWorkspaces, IRemoteWorkspace diff --git a/content/api-reference/java/protocols/i-resolvable.mdx b/content/api-reference/java/protocols/i-resolvable.mdx index 43dca7d..ac20da4 100644 --- a/content/api-reference/java/protocols/i-resolvable.mdx +++ b/content/api-reference/java/protocols/i-resolvable.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResolvable description: CDKTN Core API Reference for IResolvable in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyListList, AnyListMap, AnyMap, AnyMapList, BooleanList, BooleanListList, BooleanListMap, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, LazyBase, MapList, NumberListList, NumberListMap, NumberMap, NumberMapList, StringListList, StringListMap, StringMap, StringMapList, StringMapMap, IResolvable diff --git a/content/api-reference/java/protocols/i-resolve-context.mdx b/content/api-reference/java/protocols/i-resolve-context.mdx index 85fd52d..d767f4e 100644 --- a/content/api-reference/java/protocols/i-resolve-context.mdx +++ b/content/api-reference/java/protocols/i-resolve-context.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResolveContext description: CDKTN Core API Reference for IResolveContext in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IResolveContext diff --git a/content/api-reference/java/protocols/i-resource-constructor.mdx b/content/api-reference/java/protocols/i-resource-constructor.mdx index cd22c82..cf51fe3 100644 --- a/content/api-reference/java/protocols/i-resource-constructor.mdx +++ b/content/api-reference/java/protocols/i-resource-constructor.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResourceConstructor description: CDKTN Core API Reference for IResourceConstructor in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IResourceConstructor diff --git a/content/api-reference/java/protocols/i-resource.mdx b/content/api-reference/java/protocols/i-resource.mdx index 3c4208e..8dde034 100644 --- a/content/api-reference/java/protocols/i-resource.mdx +++ b/content/api-reference/java/protocols/i-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResource description: CDKTN Core API Reference for IResource in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Extends:* software.constructs.IConstruct diff --git a/content/api-reference/java/protocols/i-scope-callback.mdx b/content/api-reference/java/protocols/i-scope-callback.mdx index a634a86..a5d3145 100644 --- a/content/api-reference/java/protocols/i-scope-callback.mdx +++ b/content/api-reference/java/protocols/i-scope-callback.mdx @@ -4,7 +4,7 @@ sidebarTitle: IScopeCallback description: CDKTN Core API Reference for IScopeCallback in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IScopeCallback diff --git a/content/api-reference/java/protocols/i-stack-synthesizer.mdx b/content/api-reference/java/protocols/i-stack-synthesizer.mdx index ccac7f7..ae3cd42 100644 --- a/content/api-reference/java/protocols/i-stack-synthesizer.mdx +++ b/content/api-reference/java/protocols/i-stack-synthesizer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IStackSynthesizer description: CDKTN Core API Reference for IStackSynthesizer in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IStackSynthesizer diff --git a/content/api-reference/java/protocols/i-string-producer.mdx b/content/api-reference/java/protocols/i-string-producer.mdx index 81a45c0..88b6343 100644 --- a/content/api-reference/java/protocols/i-string-producer.mdx +++ b/content/api-reference/java/protocols/i-string-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IStringProducer description: CDKTN Core API Reference for IStringProducer in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IStringProducer diff --git a/content/api-reference/java/protocols/i-synthesis-session.mdx b/content/api-reference/java/protocols/i-synthesis-session.mdx index 0e64e3a..3a68c88 100644 --- a/content/api-reference/java/protocols/i-synthesis-session.mdx +++ b/content/api-reference/java/protocols/i-synthesis-session.mdx @@ -4,7 +4,7 @@ sidebarTitle: ISynthesisSession description: CDKTN Core API Reference for ISynthesisSession in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* ISynthesisSession diff --git a/content/api-reference/java/protocols/i-terraform-addressable.mdx b/content/api-reference/java/protocols/i-terraform-addressable.mdx index 8589294..4f5c8e2 100644 --- a/content/api-reference/java/protocols/i-terraform-addressable.mdx +++ b/content/api-reference/java/protocols/i-terraform-addressable.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformAddressable description: CDKTN Core API Reference for ITerraformAddressable in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyListList, AnyListMap, AnyMap, AnyMapList, BooleanList, BooleanListList, BooleanListMap, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, DataResource, DataTerraformRemoteState, DataTerraformRemoteStateAzurerm, DataTerraformRemoteStateConsul, DataTerraformRemoteStateCos, DataTerraformRemoteStateGcs, DataTerraformRemoteStateHttp, DataTerraformRemoteStateLocal, DataTerraformRemoteStateOss, DataTerraformRemoteStatePg, DataTerraformRemoteStateS3, DataTerraformRemoteStateSwift, MapList, NumberListList, NumberListMap, NumberMap, NumberMapList, StringListList, StringListMap, StringMap, StringMapList, StringMapMap, TerraformDataSource, TerraformHclModule, TerraformLocal, TerraformModule, TerraformRemoteState, TerraformResource, TerraformVariable, ITerraformAddressable, ITerraformDependable diff --git a/content/api-reference/java/protocols/i-terraform-dependable.mdx b/content/api-reference/java/protocols/i-terraform-dependable.mdx index dab9f84..7cad77d 100644 --- a/content/api-reference/java/protocols/i-terraform-dependable.mdx +++ b/content/api-reference/java/protocols/i-terraform-dependable.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformDependable description: CDKTN Core API Reference for ITerraformDependable in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Extends:* ITerraformAddressable diff --git a/content/api-reference/java/protocols/i-terraform-iterator.mdx b/content/api-reference/java/protocols/i-terraform-iterator.mdx index f632821..0000231 100644 --- a/content/api-reference/java/protocols/i-terraform-iterator.mdx +++ b/content/api-reference/java/protocols/i-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformIterator description: CDKTN Core API Reference for ITerraformIterator in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DynamicListTerraformIterator, ListTerraformIterator, MapTerraformIterator, ResourceTerraformIterator, TerraformIterator, ITerraformIterator diff --git a/content/api-reference/java/protocols/i-terraform-resource.mdx b/content/api-reference/java/protocols/i-terraform-resource.mdx index 97daec2..c51950c 100644 --- a/content/api-reference/java/protocols/i-terraform-resource.mdx +++ b/content/api-reference/java/protocols/i-terraform-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformResource description: CDKTN Core API Reference for ITerraformResource in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DataResource, TerraformDataSource, TerraformResource, ITerraformResource diff --git a/content/api-reference/java/protocols/i-token-mapper.mdx b/content/api-reference/java/protocols/i-token-mapper.mdx index a1ea07d..d0b5ab3 100644 --- a/content/api-reference/java/protocols/i-token-mapper.mdx +++ b/content/api-reference/java/protocols/i-token-mapper.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITokenMapper description: CDKTN Core API Reference for ITokenMapper in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* ITokenMapper diff --git a/content/api-reference/java/protocols/i-token-resolver.mdx b/content/api-reference/java/protocols/i-token-resolver.mdx index 9550df6..71a54da 100644 --- a/content/api-reference/java/protocols/i-token-resolver.mdx +++ b/content/api-reference/java/protocols/i-token-resolver.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITokenResolver description: CDKTN Core API Reference for ITokenResolver in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DefaultTokenResolver, ITokenResolver diff --git a/content/api-reference/java/structs/app-config.mdx b/content/api-reference/java/structs/app-config.mdx index c42c9a7..621051b 100644 --- a/content/api-reference/java/structs/app-config.mdx +++ b/content/api-reference/java/structs/app-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: AppConfig description: CDKTN Core API Reference for AppConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/azurerm-backend-config.mdx b/content/api-reference/java/structs/azurerm-backend-config.mdx index 7f9c02d..97d3146 100644 --- a/content/api-reference/java/structs/azurerm-backend-config.mdx +++ b/content/api-reference/java/structs/azurerm-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: AzurermBackendConfig description: CDKTN Core API Reference for AzurermBackendConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as a Blob with the given Key within the Blob Container within the Blob Storage Account. diff --git a/content/api-reference/java/structs/cloud-backend-config.mdx b/content/api-reference/java/structs/cloud-backend-config.mdx index 4830ec8..37f946e 100644 --- a/content/api-reference/java/structs/cloud-backend-config.mdx +++ b/content/api-reference/java/structs/cloud-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudBackendConfig description: CDKTN Core API Reference for CloudBackendConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The Cloud Backend synthesizes a [cloud block](https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block). The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings. diff --git a/content/api-reference/java/structs/consul-backend-config.mdx b/content/api-reference/java/structs/consul-backend-config.mdx index 0e7b25e..8ec7c78 100644 --- a/content/api-reference/java/structs/consul-backend-config.mdx +++ b/content/api-reference/java/structs/consul-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: ConsulBackendConfig description: CDKTN Core API Reference for ConsulBackendConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state in the Consul KV store at a given path. This backend supports state locking. diff --git a/content/api-reference/java/structs/cos-backend-assume-role.mdx b/content/api-reference/java/structs/cos-backend-assume-role.mdx index bc943e9..21270ae 100644 --- a/content/api-reference/java/structs/cos-backend-assume-role.mdx +++ b/content/api-reference/java/structs/cos-backend-assume-role.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackendAssumeRole description: CDKTN Core API Reference for CosBackendAssumeRole in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/cos-backend-config.mdx b/content/api-reference/java/structs/cos-backend-config.mdx index e03bf0e..1a5889d 100644 --- a/content/api-reference/java/structs/cos-backend-config.mdx +++ b/content/api-reference/java/structs/cos-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackendConfig description: CDKTN Core API Reference for CosBackendConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as an object in a configurable prefix in a given bucket on Tencent Cloud Object Storage (COS). diff --git a/content/api-reference/java/structs/data-config.mdx b/content/api-reference/java/structs/data-config.mdx index 5abcf15..56ea302 100644 --- a/content/api-reference/java/structs/data-config.mdx +++ b/content/api-reference/java/structs/data-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataConfig description: CDKTN Core API Reference for DataConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/data-terraform-remote-state-azurerm-config.mdx b/content/api-reference/java/structs/data-terraform-remote-state-azurerm-config.mdx index c25dcee..3add2db 100644 --- a/content/api-reference/java/structs/data-terraform-remote-state-azurerm-config.mdx +++ b/content/api-reference/java/structs/data-terraform-remote-state-azurerm-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateAzurermConfig description: CDKTN Core API Reference for DataTerraformRemoteStateAzurermConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/data-terraform-remote-state-config.mdx b/content/api-reference/java/structs/data-terraform-remote-state-config.mdx index f0b8e0d..4af1e7d 100644 --- a/content/api-reference/java/structs/data-terraform-remote-state-config.mdx +++ b/content/api-reference/java/structs/data-terraform-remote-state-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConfig description: CDKTN Core API Reference for DataTerraformRemoteStateConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/data-terraform-remote-state-consul-config.mdx b/content/api-reference/java/structs/data-terraform-remote-state-consul-config.mdx index 47bad05..931e5da 100644 --- a/content/api-reference/java/structs/data-terraform-remote-state-consul-config.mdx +++ b/content/api-reference/java/structs/data-terraform-remote-state-consul-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConsulConfig description: CDKTN Core API Reference for DataTerraformRemoteStateConsulConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/data-terraform-remote-state-cos-config.mdx b/content/api-reference/java/structs/data-terraform-remote-state-cos-config.mdx index ec29ad6..70c6f04 100644 --- a/content/api-reference/java/structs/data-terraform-remote-state-cos-config.mdx +++ b/content/api-reference/java/structs/data-terraform-remote-state-cos-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateCosConfig description: CDKTN Core API Reference for DataTerraformRemoteStateCosConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/data-terraform-remote-state-gcs-config.mdx b/content/api-reference/java/structs/data-terraform-remote-state-gcs-config.mdx index dcba892..41c3bcc 100644 --- a/content/api-reference/java/structs/data-terraform-remote-state-gcs-config.mdx +++ b/content/api-reference/java/structs/data-terraform-remote-state-gcs-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateGcsConfig description: CDKTN Core API Reference for DataTerraformRemoteStateGcsConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/data-terraform-remote-state-http-config.mdx b/content/api-reference/java/structs/data-terraform-remote-state-http-config.mdx index b9bba93..4f1494c 100644 --- a/content/api-reference/java/structs/data-terraform-remote-state-http-config.mdx +++ b/content/api-reference/java/structs/data-terraform-remote-state-http-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateHttpConfig description: CDKTN Core API Reference for DataTerraformRemoteStateHttpConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/data-terraform-remote-state-local-config.mdx b/content/api-reference/java/structs/data-terraform-remote-state-local-config.mdx index b42b330..86465aa 100644 --- a/content/api-reference/java/structs/data-terraform-remote-state-local-config.mdx +++ b/content/api-reference/java/structs/data-terraform-remote-state-local-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateLocalConfig description: CDKTN Core API Reference for DataTerraformRemoteStateLocalConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/data-terraform-remote-state-oss-config.mdx b/content/api-reference/java/structs/data-terraform-remote-state-oss-config.mdx index 504dee4..209cb74 100644 --- a/content/api-reference/java/structs/data-terraform-remote-state-oss-config.mdx +++ b/content/api-reference/java/structs/data-terraform-remote-state-oss-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateOssConfig description: CDKTN Core API Reference for DataTerraformRemoteStateOssConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/data-terraform-remote-state-pg-config.mdx b/content/api-reference/java/structs/data-terraform-remote-state-pg-config.mdx index 9402b5c..47e27b3 100644 --- a/content/api-reference/java/structs/data-terraform-remote-state-pg-config.mdx +++ b/content/api-reference/java/structs/data-terraform-remote-state-pg-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStatePgConfig description: CDKTN Core API Reference for DataTerraformRemoteStatePgConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/data-terraform-remote-state-remote-config.mdx b/content/api-reference/java/structs/data-terraform-remote-state-remote-config.mdx index b9c84f3..f7bf359 100644 --- a/content/api-reference/java/structs/data-terraform-remote-state-remote-config.mdx +++ b/content/api-reference/java/structs/data-terraform-remote-state-remote-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateRemoteConfig description: CDKTN Core API Reference for DataTerraformRemoteStateRemoteConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/data-terraform-remote-state-s3-config.mdx b/content/api-reference/java/structs/data-terraform-remote-state-s3-config.mdx index 7a55bd7..16a2def 100644 --- a/content/api-reference/java/structs/data-terraform-remote-state-s3-config.mdx +++ b/content/api-reference/java/structs/data-terraform-remote-state-s3-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateS3Config description: CDKTN Core API Reference for DataTerraformRemoteStateS3Config in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer @@ -62,6 +62,7 @@ DataTerraformRemoteStateS3Config.builder() // .stsRegion(java.lang.String) // .token(java.lang.String) // .useLegacyWorkflow(java.lang.Boolean) +// .useLockfile(java.lang.Boolean) // .usePathStyle(java.lang.Boolean) // .workspaceKeyPrefix(java.lang.String) .build(); @@ -121,6 +122,7 @@ DataTerraformRemoteStateS3Config.builder() | stsRegion | java.lang.String | (Optional) AWS region for STS. | | token | java.lang.String | (Optional) Multi-Factor Authentication (MFA) token. | | useLegacyWorkflow | java.lang.Boolean | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. | +| useLockfile | java.lang.Boolean | (Optional) Whether to use a lockfile for locking the state file. | | usePathStyle | java.lang.Boolean | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). | | workspaceKeyPrefix | java.lang.String | (Optional) Prefix applied to the state path inside the bucket. | @@ -329,7 +331,9 @@ This can also be sourced from the AWS\_DYNAMODB\_ENDPOINT environment variable. *** -### `dynamodbTable`Optional +### ~~`dynamodbTable`~~Optional + +- *Deprecated:* Use useLockfile instead, which uses S3 for locking ```java public java.lang.String getDynamodbTable(); @@ -833,6 +837,25 @@ This behavior does not align with the authentication flow of the AWS CLI or SDK' *** +### `useLockfile`Optional + +```java +public java.lang.Boolean getUseLockfile(); +``` + +- *Type:* java.lang.Boolean + +(Optional) Whether to use a lockfile for locking the state file. + +Defaults to false. +State locking is an opt-in feature of the S3 backend. +Locking can be enabled via S3 or DynamoDB (see dynamodbTable). However, DynamoDB-based locking +is deprecated and will be removed in a future minor version. To support migration from older +versions of Terraform that only support DynamoDB-based locking, the S3 (useLockfile) and DynamoDB +(dynamodbTable) arguments can be configured simultaneously. + +*** + ### `usePathStyle`Optional ```java diff --git a/content/api-reference/java/structs/data-terraform-remote-state-swift-config.mdx b/content/api-reference/java/structs/data-terraform-remote-state-swift-config.mdx index a33238e..02a3b0a 100644 --- a/content/api-reference/java/structs/data-terraform-remote-state-swift-config.mdx +++ b/content/api-reference/java/structs/data-terraform-remote-state-swift-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateSwiftConfig description: CDKTN Core API Reference for DataTerraformRemoteStateSwiftConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/encoding-options.mdx b/content/api-reference/java/structs/encoding-options.mdx index 6a2606d..c9ebe3f 100644 --- a/content/api-reference/java/structs/encoding-options.mdx +++ b/content/api-reference/java/structs/encoding-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: EncodingOptions description: CDKTN Core API Reference for EncodingOptions in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Properties to string encodings. diff --git a/content/api-reference/java/structs/file-provisioner.mdx b/content/api-reference/java/structs/file-provisioner.mdx index e5da641..802b525 100644 --- a/content/api-reference/java/structs/file-provisioner.mdx +++ b/content/api-reference/java/structs/file-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: FileProvisioner description: CDKTN Core API Reference for FileProvisioner in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The file provisioner copies files or directories from the machine running Terraform to the newly created resource. diff --git a/content/api-reference/java/structs/gcs-backend-config.mdx b/content/api-reference/java/structs/gcs-backend-config.mdx index 4584ad4..1d9f443 100644 --- a/content/api-reference/java/structs/gcs-backend-config.mdx +++ b/content/api-reference/java/structs/gcs-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: GcsBackendConfig description: CDKTN Core API Reference for GcsBackendConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as an object in a configurable prefix in a pre-existing bucket on Google Cloud Storage (GCS). diff --git a/content/api-reference/java/structs/http-backend-config.mdx b/content/api-reference/java/structs/http-backend-config.mdx index 1bff9bc..f79b581 100644 --- a/content/api-reference/java/structs/http-backend-config.mdx +++ b/content/api-reference/java/structs/http-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: HttpBackendConfig description: CDKTN Core API Reference for HttpBackendConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state using a simple REST client. diff --git a/content/api-reference/java/structs/lazy-any-value-options.mdx b/content/api-reference/java/structs/lazy-any-value-options.mdx index ada5b65..34b30cd 100644 --- a/content/api-reference/java/structs/lazy-any-value-options.mdx +++ b/content/api-reference/java/structs/lazy-any-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyAnyValueOptions description: CDKTN Core API Reference for LazyAnyValueOptions in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating lazy untyped tokens. diff --git a/content/api-reference/java/structs/lazy-list-value-options.mdx b/content/api-reference/java/structs/lazy-list-value-options.mdx index 1436956..fe850b8 100644 --- a/content/api-reference/java/structs/lazy-list-value-options.mdx +++ b/content/api-reference/java/structs/lazy-list-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyListValueOptions description: CDKTN Core API Reference for LazyListValueOptions in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating a lazy list token. diff --git a/content/api-reference/java/structs/lazy-string-value-options.mdx b/content/api-reference/java/structs/lazy-string-value-options.mdx index 5b3cfeb..2f70234 100644 --- a/content/api-reference/java/structs/lazy-string-value-options.mdx +++ b/content/api-reference/java/structs/lazy-string-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyStringValueOptions description: CDKTN Core API Reference for LazyStringValueOptions in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating a lazy string token. diff --git a/content/api-reference/java/structs/local-backend-config.mdx b/content/api-reference/java/structs/local-backend-config.mdx index 1604bcd..f589796 100644 --- a/content/api-reference/java/structs/local-backend-config.mdx +++ b/content/api-reference/java/structs/local-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalBackendConfig description: CDKTN Core API Reference for LocalBackendConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The local backend stores state on the local filesystem, locks that state using system APIs, and performs operations locally. diff --git a/content/api-reference/java/structs/local-exec-provisioner.mdx b/content/api-reference/java/structs/local-exec-provisioner.mdx index d69e6e1..327464c 100644 --- a/content/api-reference/java/structs/local-exec-provisioner.mdx +++ b/content/api-reference/java/structs/local-exec-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalExecProvisioner description: CDKTN Core API Reference for LocalExecProvisioner in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The local-exec provisioner invokes a local executable after a resource is created. diff --git a/content/api-reference/java/structs/oss-assume-role.mdx b/content/api-reference/java/structs/oss-assume-role.mdx index bca7734..526a08d 100644 --- a/content/api-reference/java/structs/oss-assume-role.mdx +++ b/content/api-reference/java/structs/oss-assume-role.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssAssumeRole description: CDKTN Core API Reference for OssAssumeRole in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/oss-backend-config.mdx b/content/api-reference/java/structs/oss-backend-config.mdx index 7a70c4d..31b3f4d 100644 --- a/content/api-reference/java/structs/oss-backend-config.mdx +++ b/content/api-reference/java/structs/oss-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssBackendConfig description: CDKTN Core API Reference for OssBackendConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/pg-backend-config.mdx b/content/api-reference/java/structs/pg-backend-config.mdx index ab8729f..41e74ef 100644 --- a/content/api-reference/java/structs/pg-backend-config.mdx +++ b/content/api-reference/java/structs/pg-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: PgBackendConfig description: CDKTN Core API Reference for PgBackendConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/postcondition.mdx b/content/api-reference/java/structs/postcondition.mdx index dd005d6..5ff5da4 100644 --- a/content/api-reference/java/structs/postcondition.mdx +++ b/content/api-reference/java/structs/postcondition.mdx @@ -4,7 +4,7 @@ sidebarTitle: Postcondition description: CDKTN Core API Reference for Postcondition in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Terraform checks a postcondition after evaluating the object it is associated with. diff --git a/content/api-reference/java/structs/precondition.mdx b/content/api-reference/java/structs/precondition.mdx index d031c44..d328d81 100644 --- a/content/api-reference/java/structs/precondition.mdx +++ b/content/api-reference/java/structs/precondition.mdx @@ -4,7 +4,7 @@ sidebarTitle: Precondition description: CDKTN Core API Reference for Precondition in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Terraform checks a precondition before evaluating the object it is associated with. diff --git a/content/api-reference/java/structs/remote-backend-config.mdx b/content/api-reference/java/structs/remote-backend-config.mdx index eb76f4d..7edb4be 100644 --- a/content/api-reference/java/structs/remote-backend-config.mdx +++ b/content/api-reference/java/structs/remote-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteBackendConfig description: CDKTN Core API Reference for RemoteBackendConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/remote-exec-provisioner.mdx b/content/api-reference/java/structs/remote-exec-provisioner.mdx index f4d459d..48cd535 100644 --- a/content/api-reference/java/structs/remote-exec-provisioner.mdx +++ b/content/api-reference/java/structs/remote-exec-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteExecProvisioner description: CDKTN Core API Reference for RemoteExecProvisioner in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The remote-exec provisioner invokes a script on a remote resource after it is created. diff --git a/content/api-reference/java/structs/resolve-options.mdx b/content/api-reference/java/structs/resolve-options.mdx index df2d3f8..65144c1 100644 --- a/content/api-reference/java/structs/resolve-options.mdx +++ b/content/api-reference/java/structs/resolve-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: ResolveOptions description: CDKTN Core API Reference for ResolveOptions in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options to the resolve() operation. diff --git a/content/api-reference/java/structs/s3-backend-assume-role-config.mdx b/content/api-reference/java/structs/s3-backend-assume-role-config.mdx index e84303d..cd96081 100644 --- a/content/api-reference/java/structs/s3-backend-assume-role-config.mdx +++ b/content/api-reference/java/structs/s3-backend-assume-role-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendAssumeRoleConfig description: CDKTN Core API Reference for S3BackendAssumeRoleConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/s3-backend-assume-role-with-web-identity-config.mdx b/content/api-reference/java/structs/s3-backend-assume-role-with-web-identity-config.mdx index 3488e5c..7d14efc 100644 --- a/content/api-reference/java/structs/s3-backend-assume-role-with-web-identity-config.mdx +++ b/content/api-reference/java/structs/s3-backend-assume-role-with-web-identity-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendAssumeRoleWithWebIdentityConfig description: CDKTN Core API Reference for S3BackendAssumeRoleWithWebIdentityConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/s3-backend-config.mdx b/content/api-reference/java/structs/s3-backend-config.mdx index 9d79189..fa36f72 100644 --- a/content/api-reference/java/structs/s3-backend-config.mdx +++ b/content/api-reference/java/structs/s3-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendConfig description: CDKTN Core API Reference for S3BackendConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as a given key in a given bucket on Amazon S3. @@ -76,6 +76,7 @@ S3BackendConfig.builder() // .stsRegion(java.lang.String) // .token(java.lang.String) // .useLegacyWorkflow(java.lang.Boolean) +// .useLockfile(java.lang.Boolean) // .usePathStyle(java.lang.Boolean) // .workspaceKeyPrefix(java.lang.String) .build(); @@ -133,6 +134,7 @@ S3BackendConfig.builder() | stsRegion | java.lang.String | (Optional) AWS region for STS. | | token | java.lang.String | (Optional) Multi-Factor Authentication (MFA) token. | | useLegacyWorkflow | java.lang.Boolean | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. | +| useLockfile | java.lang.Boolean | (Optional) Whether to use a lockfile for locking the state file. | | usePathStyle | java.lang.Boolean | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). | | workspaceKeyPrefix | java.lang.String | (Optional) Prefix applied to the state path inside the bucket. | @@ -321,7 +323,9 @@ This can also be sourced from the AWS\_DYNAMODB\_ENDPOINT environment variable. *** -### `dynamodbTable`Optional +### ~~`dynamodbTable`~~Optional + +- *Deprecated:* Use useLockfile instead, which uses S3 for locking ```java public java.lang.String getDynamodbTable(); @@ -825,6 +829,25 @@ This behavior does not align with the authentication flow of the AWS CLI or SDK' *** +### `useLockfile`Optional + +```java +public java.lang.Boolean getUseLockfile(); +``` + +- *Type:* java.lang.Boolean + +(Optional) Whether to use a lockfile for locking the state file. + +Defaults to false. +State locking is an opt-in feature of the S3 backend. +Locking can be enabled via S3 or DynamoDB (see dynamodbTable). However, DynamoDB-based locking +is deprecated and will be removed in a future minor version. To support migration from older +versions of Terraform that only support DynamoDB-based locking, the S3 (useLockfile) and DynamoDB +(dynamodbTable) arguments can be configured simultaneously. + +*** + ### `usePathStyle`Optional ```java diff --git a/content/api-reference/java/structs/s3-backend-endpoint-config.mdx b/content/api-reference/java/structs/s3-backend-endpoint-config.mdx index 9261505..58cb577 100644 --- a/content/api-reference/java/structs/s3-backend-endpoint-config.mdx +++ b/content/api-reference/java/structs/s3-backend-endpoint-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendEndpointConfig description: CDKTN Core API Reference for S3BackendEndpointConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/ssh-provisioner-connection.mdx b/content/api-reference/java/structs/ssh-provisioner-connection.mdx index 030a4f1..f9f51cb 100644 --- a/content/api-reference/java/structs/ssh-provisioner-connection.mdx +++ b/content/api-reference/java/structs/ssh-provisioner-connection.mdx @@ -4,7 +4,7 @@ sidebarTitle: SSHProvisionerConnection description: CDKTN Core API Reference for SSHProvisionerConnection in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect. diff --git a/content/api-reference/java/structs/stack-annotation.mdx b/content/api-reference/java/structs/stack-annotation.mdx index 026afab..0086851 100644 --- a/content/api-reference/java/structs/stack-annotation.mdx +++ b/content/api-reference/java/structs/stack-annotation.mdx @@ -4,7 +4,7 @@ sidebarTitle: StackAnnotation description: CDKTN Core API Reference for StackAnnotation in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/stack-manifest.mdx b/content/api-reference/java/structs/stack-manifest.mdx index 8f3d6f3..d1f5cf3 100644 --- a/content/api-reference/java/structs/stack-manifest.mdx +++ b/content/api-reference/java/structs/stack-manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: StackManifest description: CDKTN Core API Reference for StackManifest in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/swift-backend-config.mdx b/content/api-reference/java/structs/swift-backend-config.mdx index 024dafa..f8b89c3 100644 --- a/content/api-reference/java/structs/swift-backend-config.mdx +++ b/content/api-reference/java/structs/swift-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: SwiftBackendConfig description: CDKTN Core API Reference for SwiftBackendConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-asset-config.mdx b/content/api-reference/java/structs/terraform-asset-config.mdx index c04c076..374b310 100644 --- a/content/api-reference/java/structs/terraform-asset-config.mdx +++ b/content/api-reference/java/structs/terraform-asset-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformAssetConfig description: CDKTN Core API Reference for TerraformAssetConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-condition.mdx b/content/api-reference/java/structs/terraform-condition.mdx index 3540481..a102d38 100644 --- a/content/api-reference/java/structs/terraform-condition.mdx +++ b/content/api-reference/java/structs/terraform-condition.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformCondition description: CDKTN Core API Reference for TerraformCondition in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-constructor.mdx b/content/api-reference/java/structs/terraform-constructor.mdx index 4e5074e..cdcb93e 100644 --- a/content/api-reference/java/structs/terraform-constructor.mdx +++ b/content/api-reference/java/structs/terraform-constructor.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformConstructor description: CDKTN Core API Reference for TerraformConstructor in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-element-metadata.mdx b/content/api-reference/java/structs/terraform-element-metadata.mdx index b4af0e3..a5a41ec 100644 --- a/content/api-reference/java/structs/terraform-element-metadata.mdx +++ b/content/api-reference/java/structs/terraform-element-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformElementMetadata description: CDKTN Core API Reference for TerraformElementMetadata in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-hcl-module-config.mdx b/content/api-reference/java/structs/terraform-hcl-module-config.mdx index c42b84b..658a48b 100644 --- a/content/api-reference/java/structs/terraform-hcl-module-config.mdx +++ b/content/api-reference/java/structs/terraform-hcl-module-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformHclModuleConfig description: CDKTN Core API Reference for TerraformHclModuleConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-meta-arguments.mdx b/content/api-reference/java/structs/terraform-meta-arguments.mdx index 4e98fc1..012b2d3 100644 --- a/content/api-reference/java/structs/terraform-meta-arguments.mdx +++ b/content/api-reference/java/structs/terraform-meta-arguments.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformMetaArguments description: CDKTN Core API Reference for TerraformMetaArguments in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-module-config.mdx b/content/api-reference/java/structs/terraform-module-config.mdx index d61fe2e..ebfdfc3 100644 --- a/content/api-reference/java/structs/terraform-module-config.mdx +++ b/content/api-reference/java/structs/terraform-module-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleConfig description: CDKTN Core API Reference for TerraformModuleConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-module-provider.mdx b/content/api-reference/java/structs/terraform-module-provider.mdx index f2bb17a..8c2746a 100644 --- a/content/api-reference/java/structs/terraform-module-provider.mdx +++ b/content/api-reference/java/structs/terraform-module-provider.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleProvider description: CDKTN Core API Reference for TerraformModuleProvider in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-module-user-config.mdx b/content/api-reference/java/structs/terraform-module-user-config.mdx index f3388cd..0d4a417 100644 --- a/content/api-reference/java/structs/terraform-module-user-config.mdx +++ b/content/api-reference/java/structs/terraform-module-user-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleUserConfig description: CDKTN Core API Reference for TerraformModuleUserConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-output-config.mdx b/content/api-reference/java/structs/terraform-output-config.mdx index 85e6de3..5780ddb 100644 --- a/content/api-reference/java/structs/terraform-output-config.mdx +++ b/content/api-reference/java/structs/terraform-output-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformOutputConfig description: CDKTN Core API Reference for TerraformOutputConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-provider-config.mdx b/content/api-reference/java/structs/terraform-provider-config.mdx index 800d1a5..5ad2511 100644 --- a/content/api-reference/java/structs/terraform-provider-config.mdx +++ b/content/api-reference/java/structs/terraform-provider-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProviderConfig description: CDKTN Core API Reference for TerraformProviderConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-provider-generator-metadata.mdx b/content/api-reference/java/structs/terraform-provider-generator-metadata.mdx index ca99061..3b03533 100644 --- a/content/api-reference/java/structs/terraform-provider-generator-metadata.mdx +++ b/content/api-reference/java/structs/terraform-provider-generator-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProviderGeneratorMetadata description: CDKTN Core API Reference for TerraformProviderGeneratorMetadata in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-resource-config.mdx b/content/api-reference/java/structs/terraform-resource-config.mdx index 5ac576a..40a1016 100644 --- a/content/api-reference/java/structs/terraform-resource-config.mdx +++ b/content/api-reference/java/structs/terraform-resource-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceConfig description: CDKTN Core API Reference for TerraformResourceConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-resource-import.mdx b/content/api-reference/java/structs/terraform-resource-import.mdx index ade870b..cd749b6 100644 --- a/content/api-reference/java/structs/terraform-resource-import.mdx +++ b/content/api-reference/java/structs/terraform-resource-import.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceImport description: CDKTN Core API Reference for TerraformResourceImport in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-resource-lifecycle.mdx b/content/api-reference/java/structs/terraform-resource-lifecycle.mdx index ed01f38..e122e2f 100644 --- a/content/api-reference/java/structs/terraform-resource-lifecycle.mdx +++ b/content/api-reference/java/structs/terraform-resource-lifecycle.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceLifecycle description: CDKTN Core API Reference for TerraformResourceLifecycle in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-resource-move-by-id.mdx b/content/api-reference/java/structs/terraform-resource-move-by-id.mdx index 0af1b9e..1cd6b11 100644 --- a/content/api-reference/java/structs/terraform-resource-move-by-id.mdx +++ b/content/api-reference/java/structs/terraform-resource-move-by-id.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceMoveById description: CDKTN Core API Reference for TerraformResourceMoveById in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-resource-move-by-target.mdx b/content/api-reference/java/structs/terraform-resource-move-by-target.mdx index 29d4bc6..e136690 100644 --- a/content/api-reference/java/structs/terraform-resource-move-by-target.mdx +++ b/content/api-reference/java/structs/terraform-resource-move-by-target.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceMoveByTarget description: CDKTN Core API Reference for TerraformResourceMoveByTarget in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-stack-metadata.mdx b/content/api-reference/java/structs/terraform-stack-metadata.mdx index 18e0b16..995d1c1 100644 --- a/content/api-reference/java/structs/terraform-stack-metadata.mdx +++ b/content/api-reference/java/structs/terraform-stack-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformStackMetadata description: CDKTN Core API Reference for TerraformStackMetadata in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-variable-config.mdx b/content/api-reference/java/structs/terraform-variable-config.mdx index a61b8bb..56a5cb4 100644 --- a/content/api-reference/java/structs/terraform-variable-config.mdx +++ b/content/api-reference/java/structs/terraform-variable-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariableConfig description: CDKTN Core API Reference for TerraformVariableConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/terraform-variable-validation-config.mdx b/content/api-reference/java/structs/terraform-variable-validation-config.mdx index c8e0246..70f4fb8 100644 --- a/content/api-reference/java/structs/terraform-variable-validation-config.mdx +++ b/content/api-reference/java/structs/terraform-variable-validation-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariableValidationConfig description: CDKTN Core API Reference for TerraformVariableValidationConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Add one or more validation blocks within the variable block to specify custom conditions. diff --git a/content/api-reference/java/structs/testing-app-config.mdx b/content/api-reference/java/structs/testing-app-config.mdx index 43d3137..c36dc3d 100644 --- a/content/api-reference/java/structs/testing-app-config.mdx +++ b/content/api-reference/java/structs/testing-app-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TestingAppConfig description: CDKTN Core API Reference for TestingAppConfig in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/java/structs/winrm-provisioner-connection.mdx b/content/api-reference/java/structs/winrm-provisioner-connection.mdx index 3eef6b4..d7666a8 100644 --- a/content/api-reference/java/structs/winrm-provisioner-connection.mdx +++ b/content/api-reference/java/structs/winrm-provisioner-connection.mdx @@ -4,7 +4,7 @@ sidebarTitle: WinrmProvisionerConnection description: CDKTN Core API Reference for WinrmProvisionerConnection in Java. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect. diff --git a/content/api-reference/python/classes/annotations.mdx b/content/api-reference/python/classes/annotations.mdx index 31b4f50..b6801c6 100644 --- a/content/api-reference/python/classes/annotations.mdx +++ b/content/api-reference/python/classes/annotations.mdx @@ -4,7 +4,7 @@ sidebarTitle: Annotations description: CDKTN Core API Reference for Annotations in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Includes API for attaching annotations such as warning messages to constructs. diff --git a/content/api-reference/python/classes/any-list-list.mdx b/content/api-reference/python/classes/any-list-list.mdx index a8ae56e..ac41099 100644 --- a/content/api-reference/python/classes/any-list-list.mdx +++ b/content/api-reference/python/classes/any-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyListList description: CDKTN Core API Reference for AnyListList in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/any-list-map.mdx b/content/api-reference/python/classes/any-list-map.mdx index 35aa522..885377d 100644 --- a/content/api-reference/python/classes/any-list-map.mdx +++ b/content/api-reference/python/classes/any-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyListMap description: CDKTN Core API Reference for AnyListMap in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/any-map-list.mdx b/content/api-reference/python/classes/any-map-list.mdx index c725897..2f07553 100644 --- a/content/api-reference/python/classes/any-map-list.mdx +++ b/content/api-reference/python/classes/any-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyMapList description: CDKTN Core API Reference for AnyMapList in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/any-map.mdx b/content/api-reference/python/classes/any-map.mdx index 79cd5e8..2d6e4ed 100644 --- a/content/api-reference/python/classes/any-map.mdx +++ b/content/api-reference/python/classes/any-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyMap description: CDKTN Core API Reference for AnyMap in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/python/classes/aspects.mdx b/content/api-reference/python/classes/aspects.mdx index d0a2684..79c8eb9 100644 --- a/content/api-reference/python/classes/aspects.mdx +++ b/content/api-reference/python/classes/aspects.mdx @@ -4,7 +4,7 @@ sidebarTitle: Aspects description: CDKTN Core API Reference for Aspects in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis. diff --git a/content/api-reference/python/classes/assertion-return.mdx b/content/api-reference/python/classes/assertion-return.mdx index 571e1b1..af9ac28 100644 --- a/content/api-reference/python/classes/assertion-return.mdx +++ b/content/api-reference/python/classes/assertion-return.mdx @@ -4,7 +4,7 @@ sidebarTitle: AssertionReturn description: CDKTN Core API Reference for AssertionReturn in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Class representing the contents of a return by an assertion. diff --git a/content/api-reference/python/classes/boolean-list-list.mdx b/content/api-reference/python/classes/boolean-list-list.mdx index 55a5467..28c6d59 100644 --- a/content/api-reference/python/classes/boolean-list-list.mdx +++ b/content/api-reference/python/classes/boolean-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanListList description: CDKTN Core API Reference for BooleanListList in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/boolean-list-map.mdx b/content/api-reference/python/classes/boolean-list-map.mdx index e60fed3..6e6b628 100644 --- a/content/api-reference/python/classes/boolean-list-map.mdx +++ b/content/api-reference/python/classes/boolean-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanListMap description: CDKTN Core API Reference for BooleanListMap in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/boolean-list.mdx b/content/api-reference/python/classes/boolean-list.mdx index bcb0e8a..9dc0d77 100644 --- a/content/api-reference/python/classes/boolean-list.mdx +++ b/content/api-reference/python/classes/boolean-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanList description: CDKTN Core API Reference for BooleanList in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/boolean-map-list.mdx b/content/api-reference/python/classes/boolean-map-list.mdx index 4aa6e59..30f8d28 100644 --- a/content/api-reference/python/classes/boolean-map-list.mdx +++ b/content/api-reference/python/classes/boolean-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanMapList description: CDKTN Core API Reference for BooleanMapList in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/boolean-map.mdx b/content/api-reference/python/classes/boolean-map.mdx index 72c49fa..1052251 100644 --- a/content/api-reference/python/classes/boolean-map.mdx +++ b/content/api-reference/python/classes/boolean-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanMap description: CDKTN Core API Reference for BooleanMap in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/python/classes/cloud-workspace.mdx b/content/api-reference/python/classes/cloud-workspace.mdx index c26ef19..0ce35f8 100644 --- a/content/api-reference/python/classes/cloud-workspace.mdx +++ b/content/api-reference/python/classes/cloud-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudWorkspace description: CDKTN Core API Reference for CloudWorkspace in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} A cloud workspace can either be a single named workspace, or a list of tagged workspaces. diff --git a/content/api-reference/python/classes/complex-computed-list.mdx b/content/api-reference/python/classes/complex-computed-list.mdx index 7a3201d..20f4b50 100644 --- a/content/api-reference/python/classes/complex-computed-list.mdx +++ b/content/api-reference/python/classes/complex-computed-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexComputedList description: CDKTN Core API Reference for ComplexComputedList in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IInterpolatingParent, IResolvable, ITerraformAddressable diff --git a/content/api-reference/python/classes/complex-list.mdx b/content/api-reference/python/classes/complex-list.mdx index 64b028a..13ee764 100644 --- a/content/api-reference/python/classes/complex-list.mdx +++ b/content/api-reference/python/classes/complex-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexList description: CDKTN Core API Reference for ComplexList in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/python/classes/complex-map.mdx b/content/api-reference/python/classes/complex-map.mdx index 4e553b6..2a15ff3 100644 --- a/content/api-reference/python/classes/complex-map.mdx +++ b/content/api-reference/python/classes/complex-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexMap description: CDKTN Core API Reference for ComplexMap in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/python/classes/complex-object.mdx b/content/api-reference/python/classes/complex-object.mdx index 2f1f380..de7ed1c 100644 --- a/content/api-reference/python/classes/complex-object.mdx +++ b/content/api-reference/python/classes/complex-object.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexObject description: CDKTN Core API Reference for ComplexObject in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IInterpolatingParent, IResolvable, ITerraformAddressable diff --git a/content/api-reference/python/classes/default-token-resolver.mdx b/content/api-reference/python/classes/default-token-resolver.mdx index 5fb1a87..2d5541f 100644 --- a/content/api-reference/python/classes/default-token-resolver.mdx +++ b/content/api-reference/python/classes/default-token-resolver.mdx @@ -4,7 +4,7 @@ sidebarTitle: DefaultTokenResolver description: CDKTN Core API Reference for DefaultTokenResolver in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITokenResolver diff --git a/content/api-reference/python/classes/dynamic-list-terraform-iterator.mdx b/content/api-reference/python/classes/dynamic-list-terraform-iterator.mdx index 1eb6763..fc25bab 100644 --- a/content/api-reference/python/classes/dynamic-list-terraform-iterator.mdx +++ b/content/api-reference/python/classes/dynamic-list-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: DynamicListTerraformIterator description: CDKTN Core API Reference for DynamicListTerraformIterator in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/fn-generated.mdx b/content/api-reference/python/classes/fn-generated.mdx index 3dfb4cc..18e2fd1 100644 --- a/content/api-reference/python/classes/fn-generated.mdx +++ b/content/api-reference/python/classes/fn-generated.mdx @@ -4,7 +4,7 @@ sidebarTitle: FnGenerated description: CDKTN Core API Reference for FnGenerated in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -29,6 +29,7 @@ cdktn.FnGenerated() | anytrue | [anytrue](https://developer.hashicorp.com/terraform/language/functions/anytrue) returns `true` if any element in a given collection is `true` or `"true"`. It also returns `false` if the collection is empty. | | base64decode | [base64decode](https://developer.hashicorp.com/terraform/language/functions/base64decode) takes a string containing a Base64 character sequence and returns the original string. | | base64encode | [base64encode](https://developer.hashicorp.com/terraform/language/functions/base64encode) applies Base64 encoding to a string. | +| base64gunzip | [base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. | | base64gzip | [base64gzip](https://developer.hashicorp.com/terraform/language/functions/base64gzip) compresses a string with gzip and then encodes the result in Base64 encoding. | | base64sha256 | [base64sha256](https://developer.hashicorp.com/terraform/language/functions/base64sha256) computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()` returns hexadecimal representation. | | base64sha512 | [base64sha512](https://developer.hashicorp.com/terraform/language/functions/base64sha512) computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha512("test"))` since `sha512()` returns hexadecimal representation. | @@ -37,6 +38,7 @@ cdktn.FnGenerated() | ceil | [ceil](https://developer.hashicorp.com/terraform/language/functions/ceil) returns the closest whole number that is greater than or equal to the given value, which may be a fraction. | | chomp | [chomp](https://developer.hashicorp.com/terraform/language/functions/chomp) removes newline characters at the end of a string. | | chunklist | [chunklist](https://developer.hashicorp.com/terraform/language/functions/chunklist) splits a single list into fixed-size chunks, returning a list of lists. | +| cidrcontains | [cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. | | cidrhost | [cidrhost](https://developer.hashicorp.com/terraform/language/functions/cidrhost) calculates a full host IP address for a given host number within a given IP network address prefix. | | cidrnetmask | [cidrnetmask](https://developer.hashicorp.com/terraform/language/functions/cidrnetmask) converts an IPv4 address prefix given in CIDR notation into a subnet mask address. | | cidrsubnet | [cidrsubnet](https://developer.hashicorp.com/terraform/language/functions/cidrsubnet) calculates a subnet address within given IP network address prefix. | @@ -46,11 +48,13 @@ cdktn.FnGenerated() | compact | [compact](https://developer.hashicorp.com/terraform/language/functions/compact) takes a list of strings and returns a new list with any empty string elements removed. | | concat | [concat](https://developer.hashicorp.com/terraform/language/functions/concat) takes two or more lists and combines them into a single list. | | contains | [contains](https://developer.hashicorp.com/terraform/language/functions/contains) determines whether a given list or set contains a given single value as one of its elements. | +| convert | [convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. | | csvdecode | [csvdecode](https://developer.hashicorp.com/terraform/language/functions/csvdecode) decodes a string containing CSV-formatted data and produces a list of maps representing that data. | | dirname | [dirname](https://developer.hashicorp.com/terraform/language/functions/dirname) takes a string containing a filesystem path and removes the last portion from it. | | distinct | [distinct](https://developer.hashicorp.com/terraform/language/functions/distinct) takes a list and returns a new list with any duplicate elements removed. | | element | [element](https://developer.hashicorp.com/terraform/language/functions/element) retrieves a single element from a list. | | endswith | [endswith](https://developer.hashicorp.com/terraform/language/functions/endswith) takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix. | +| ephemeralasnull | [ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. | | file | [file](https://developer.hashicorp.com/terraform/language/functions/file) reads the contents of a file at the given path and returns them as a string. | | filebase64 | [filebase64](https://developer.hashicorp.com/terraform/language/functions/filebase64) reads the contents of a file at the given path and returns them as a base64-encoded string. | | filebase64sha256 | [filebase64sha256](https://developer.hashicorp.com/terraform/language/functions/filebase64sha256) is a variant of `base64sha256` that hashes the contents of a given file rather than a literal string. | @@ -68,6 +72,7 @@ cdktn.FnGenerated() | formatlist | [formatlist](https://developer.hashicorp.com/terraform/language/functions/formatlist) produces a list of strings by formatting a number of other values according to a specification string. | | indent | [indent](https://developer.hashicorp.com/terraform/language/functions/indent) adds a given number of spaces to the beginnings of all but the first line in a given multi-line string. | | index | [index](https://developer.hashicorp.com/terraform/language/functions/index) finds the element index for a given value in a list. | +| issensitive | [issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. | | jsondecode | [jsondecode](https://developer.hashicorp.com/terraform/language/functions/jsondecode) interprets a given string as JSON, returning a representation of the result of decoding that string. | | jsonencode | [jsonencode](https://developer.hashicorp.com/terraform/language/functions/jsonencode) encodes a given value to a string using JSON syntax. | | keys | [keys](https://developer.hashicorp.com/terraform/language/functions/keys) takes a map and returns a list containing the keys from that map. | @@ -108,6 +113,7 @@ cdktn.FnGenerated() | substr | [substr](https://developer.hashicorp.com/terraform/language/functions/substr) extracts a substring from a given string by offset and (maximum) length. | | sum | [sum](https://developer.hashicorp.com/terraform/language/functions/sum) takes a list or set of numbers and returns the sum of those numbers. | | templatefile | [templatefile](https://developer.hashicorp.com/terraform/language/functions/templatefile) reads the file at the given path and renders its content as a template using a supplied set of template variables. | +| templatestring | [templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. | | textdecodebase64 | [textdecodebase64](https://developer.hashicorp.com/terraform/language/functions/textdecodebase64) function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding. | | textencodebase64 | [textencodebase64](https://developer.hashicorp.com/terraform/language/functions/textencodebase64) encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters. | | timeadd | [timeadd](https://developer.hashicorp.com/terraform/language/functions/timeadd) adds a duration to a timestamp, returning a new timestamp. | @@ -127,6 +133,7 @@ cdktn.FnGenerated() | trimsuffix | [trimsuffix](https://developer.hashicorp.com/terraform/language/functions/trimsuffix) removes the specified suffix from the end of the given string. | | try | [try](https://developer.hashicorp.com/terraform/language/functions/try) evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors. | | upper | [upper](https://developer.hashicorp.com/terraform/language/functions/upper) converts all cased letters in the given string to uppercase. | +| urldecode | [urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. | | urlencode | [urlencode](https://developer.hashicorp.com/terraform/language/functions/urlencode) applies URL encoding to a given string. | | uuid | [uuid](https://developer.hashicorp.com/terraform/language/functions/uuid) generates a unique identifier string. | | uuidv5 | [uuidv5](https://developer.hashicorp.com/terraform/language/functions/uuidv5) generates a *name-based* UUID, as described in [RFC 4122 section 4.3](https://tools.ietf.org/html/rfc4122#section-4.3), also known as a "version 5" UUID. | @@ -245,6 +252,24 @@ cdktn.FnGenerated.base64encode( *** +### `base64gunzip` + +```python +import cdktn + +cdktn.FnGenerated.base64gunzip( + str: str +) +``` + +[base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. + +#### `str`Required + +- *Type:* str + +*** + ### `base64gzip` ```python @@ -396,6 +421,31 @@ cdktn.FnGenerated.chunklist( *** +### `cidrcontains` + +```python +import cdktn + +cdktn.FnGenerated.cidrcontains( + containing_prefix: str, + contained_ip_or_prefix: str +) +``` + +[cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. + +#### `containing_prefix`Required + +- *Type:* str + +*** + +#### `contained_ip_or_prefix`Required + +- *Type:* str + +*** + ### `cidrhost` ```python @@ -593,6 +643,31 @@ cdktn.FnGenerated.contains( *** +### `convert` + +```python +import cdktn + +cdktn.FnGenerated.convert( + value: typing.Any, + type: typing.Any +) +``` + +[convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. + +#### `value`Required + +- *Type:* typing.Any + +*** + +#### `type`Required + +- *Type:* typing.Any + +*** + ### `csvdecode` ```python @@ -697,6 +772,24 @@ cdktn.FnGenerated.endswith( *** +### `ephemeralasnull` + +```python +import cdktn + +cdktn.FnGenerated.ephemeralasnull( + value: typing.Any +) +``` + +[ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. + +#### `value`Required + +- *Type:* typing.Any + +*** + ### `file` ```python @@ -1045,6 +1138,24 @@ cdktn.FnGenerated.index( *** +### `issensitive` + +```python +import cdktn + +cdktn.FnGenerated.issensitive( + value: typing.Any +) +``` + +[issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. + +#### `value`Required + +- *Type:* typing.Any + +*** + ### `jsondecode` ```python @@ -1904,6 +2015,31 @@ cdktn.FnGenerated.templatefile( *** +### `templatestring` + +```python +import cdktn + +cdktn.FnGenerated.templatestring( + template: str, + vars: typing.Any +) +``` + +[templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. + +#### `template`Required + +- *Type:* str + +*** + +#### `vars`Required + +- *Type:* typing.Any + +*** + ### `textdecodebase64` ```python @@ -2287,6 +2423,24 @@ cdktn.FnGenerated.upper( *** +### `urldecode` + +```python +import cdktn + +cdktn.FnGenerated.urldecode( + str: str +) +``` + +[urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. + +#### `str`Required + +- *Type:* str + +*** + ### `urlencode` ```python diff --git a/content/api-reference/python/classes/fn.mdx b/content/api-reference/python/classes/fn.mdx index 6969a44..d9db9d2 100644 --- a/content/api-reference/python/classes/fn.mdx +++ b/content/api-reference/python/classes/fn.mdx @@ -4,7 +4,7 @@ sidebarTitle: Fn description: CDKTN Core API Reference for Fn in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -29,6 +29,7 @@ cdktn.Fn() | anytrue | [anytrue](https://developer.hashicorp.com/terraform/language/functions/anytrue) returns `true` if any element in a given collection is `true` or `"true"`. It also returns `false` if the collection is empty. | | base64decode | [base64decode](https://developer.hashicorp.com/terraform/language/functions/base64decode) takes a string containing a Base64 character sequence and returns the original string. | | base64encode | [base64encode](https://developer.hashicorp.com/terraform/language/functions/base64encode) applies Base64 encoding to a string. | +| base64gunzip | [base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. | | base64gzip | [base64gzip](https://developer.hashicorp.com/terraform/language/functions/base64gzip) compresses a string with gzip and then encodes the result in Base64 encoding. | | base64sha256 | [base64sha256](https://developer.hashicorp.com/terraform/language/functions/base64sha256) computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()` returns hexadecimal representation. | | base64sha512 | [base64sha512](https://developer.hashicorp.com/terraform/language/functions/base64sha512) computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha512("test"))` since `sha512()` returns hexadecimal representation. | @@ -37,6 +38,7 @@ cdktn.Fn() | ceil | [ceil](https://developer.hashicorp.com/terraform/language/functions/ceil) returns the closest whole number that is greater than or equal to the given value, which may be a fraction. | | chomp | [chomp](https://developer.hashicorp.com/terraform/language/functions/chomp) removes newline characters at the end of a string. | | chunklist | [chunklist](https://developer.hashicorp.com/terraform/language/functions/chunklist) splits a single list into fixed-size chunks, returning a list of lists. | +| cidrcontains | [cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. | | cidrhost | [cidrhost](https://developer.hashicorp.com/terraform/language/functions/cidrhost) calculates a full host IP address for a given host number within a given IP network address prefix. | | cidrnetmask | [cidrnetmask](https://developer.hashicorp.com/terraform/language/functions/cidrnetmask) converts an IPv4 address prefix given in CIDR notation into a subnet mask address. | | cidrsubnet | [cidrsubnet](https://developer.hashicorp.com/terraform/language/functions/cidrsubnet) calculates a subnet address within given IP network address prefix. | @@ -46,11 +48,13 @@ cdktn.Fn() | compact | [compact](https://developer.hashicorp.com/terraform/language/functions/compact) takes a list of strings and returns a new list with any empty string elements removed. | | concat | [concat](https://developer.hashicorp.com/terraform/language/functions/concat) takes two or more lists and combines them into a single list. | | contains | [contains](https://developer.hashicorp.com/terraform/language/functions/contains) determines whether a given list or set contains a given single value as one of its elements. | +| convert | [convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. | | csvdecode | [csvdecode](https://developer.hashicorp.com/terraform/language/functions/csvdecode) decodes a string containing CSV-formatted data and produces a list of maps representing that data. | | dirname | [dirname](https://developer.hashicorp.com/terraform/language/functions/dirname) takes a string containing a filesystem path and removes the last portion from it. | | distinct | [distinct](https://developer.hashicorp.com/terraform/language/functions/distinct) takes a list and returns a new list with any duplicate elements removed. | | element | [element](https://developer.hashicorp.com/terraform/language/functions/element) retrieves a single element from a list. | | endswith | [endswith](https://developer.hashicorp.com/terraform/language/functions/endswith) takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix. | +| ephemeralasnull | [ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. | | file | [file](https://developer.hashicorp.com/terraform/language/functions/file) reads the contents of a file at the given path and returns them as a string. | | filebase64 | [filebase64](https://developer.hashicorp.com/terraform/language/functions/filebase64) reads the contents of a file at the given path and returns them as a base64-encoded string. | | filebase64sha256 | [filebase64sha256](https://developer.hashicorp.com/terraform/language/functions/filebase64sha256) is a variant of `base64sha256` that hashes the contents of a given file rather than a literal string. | @@ -68,6 +72,7 @@ cdktn.Fn() | formatlist | [formatlist](https://developer.hashicorp.com/terraform/language/functions/formatlist) produces a list of strings by formatting a number of other values according to a specification string. | | indent | [indent](https://developer.hashicorp.com/terraform/language/functions/indent) adds a given number of spaces to the beginnings of all but the first line in a given multi-line string. | | index | [index](https://developer.hashicorp.com/terraform/language/functions/index) finds the element index for a given value in a list. | +| issensitive | [issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. | | jsondecode | [jsondecode](https://developer.hashicorp.com/terraform/language/functions/jsondecode) interprets a given string as JSON, returning a representation of the result of decoding that string. | | jsonencode | [jsonencode](https://developer.hashicorp.com/terraform/language/functions/jsonencode) encodes a given value to a string using JSON syntax. | | keys | [keys](https://developer.hashicorp.com/terraform/language/functions/keys) takes a map and returns a list containing the keys from that map. | @@ -108,6 +113,7 @@ cdktn.Fn() | substr | [substr](https://developer.hashicorp.com/terraform/language/functions/substr) extracts a substring from a given string by offset and (maximum) length. | | sum | [sum](https://developer.hashicorp.com/terraform/language/functions/sum) takes a list or set of numbers and returns the sum of those numbers. | | templatefile | [templatefile](https://developer.hashicorp.com/terraform/language/functions/templatefile) reads the file at the given path and renders its content as a template using a supplied set of template variables. | +| templatestring | [templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. | | textdecodebase64 | [textdecodebase64](https://developer.hashicorp.com/terraform/language/functions/textdecodebase64) function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding. | | textencodebase64 | [textencodebase64](https://developer.hashicorp.com/terraform/language/functions/textencodebase64) encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters. | | timeadd | [timeadd](https://developer.hashicorp.com/terraform/language/functions/timeadd) adds a duration to a timestamp, returning a new timestamp. | @@ -127,6 +133,7 @@ cdktn.Fn() | trimsuffix | [trimsuffix](https://developer.hashicorp.com/terraform/language/functions/trimsuffix) removes the specified suffix from the end of the given string. | | try | [try](https://developer.hashicorp.com/terraform/language/functions/try) evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors. | | upper | [upper](https://developer.hashicorp.com/terraform/language/functions/upper) converts all cased letters in the given string to uppercase. | +| urldecode | [urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. | | urlencode | [urlencode](https://developer.hashicorp.com/terraform/language/functions/urlencode) applies URL encoding to a given string. | | uuid | [uuid](https://developer.hashicorp.com/terraform/language/functions/uuid) generates a unique identifier string. | | uuidv5 | [uuidv5](https://developer.hashicorp.com/terraform/language/functions/uuidv5) generates a *name-based* UUID, as described in [RFC 4122 section 4.3](https://tools.ietf.org/html/rfc4122#section-4.3), also known as a "version 5" UUID. | @@ -252,6 +259,24 @@ cdktn.Fn.base64encode( *** +### `base64gunzip` + +```python +import cdktn + +cdktn.Fn.base64gunzip( + str: str +) +``` + +[base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. + +#### `str`Required + +- *Type:* str + +*** + ### `base64gzip` ```python @@ -403,6 +428,31 @@ cdktn.Fn.chunklist( *** +### `cidrcontains` + +```python +import cdktn + +cdktn.Fn.cidrcontains( + containing_prefix: str, + contained_ip_or_prefix: str +) +``` + +[cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. + +#### `containing_prefix`Required + +- *Type:* str + +*** + +#### `contained_ip_or_prefix`Required + +- *Type:* str + +*** + ### `cidrhost` ```python @@ -600,6 +650,31 @@ cdktn.Fn.contains( *** +### `convert` + +```python +import cdktn + +cdktn.Fn.convert( + value: typing.Any, + type: typing.Any +) +``` + +[convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. + +#### `value`Required + +- *Type:* typing.Any + +*** + +#### `type`Required + +- *Type:* typing.Any + +*** + ### `csvdecode` ```python @@ -704,6 +779,24 @@ cdktn.Fn.endswith( *** +### `ephemeralasnull` + +```python +import cdktn + +cdktn.Fn.ephemeralasnull( + value: typing.Any +) +``` + +[ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. + +#### `value`Required + +- *Type:* typing.Any + +*** + ### `file` ```python @@ -1052,6 +1145,24 @@ cdktn.Fn.index( *** +### `issensitive` + +```python +import cdktn + +cdktn.Fn.issensitive( + value: typing.Any +) +``` + +[issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. + +#### `value`Required + +- *Type:* typing.Any + +*** + ### `jsondecode` ```python @@ -1911,6 +2022,31 @@ cdktn.Fn.templatefile( *** +### `templatestring` + +```python +import cdktn + +cdktn.Fn.templatestring( + template: str, + vars: typing.Any +) +``` + +[templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. + +#### `template`Required + +- *Type:* str + +*** + +#### `vars`Required + +- *Type:* typing.Any + +*** + ### `textdecodebase64` ```python @@ -2294,6 +2430,24 @@ cdktn.Fn.upper( *** +### `urldecode` + +```python +import cdktn + +cdktn.Fn.urldecode( + str: str +) +``` + +[urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. + +#### `str`Required + +- *Type:* str + +*** + ### `urlencode` ```python diff --git a/content/api-reference/python/classes/lazy-base.mdx b/content/api-reference/python/classes/lazy-base.mdx index 96e2e8b..11ad140 100644 --- a/content/api-reference/python/classes/lazy-base.mdx +++ b/content/api-reference/python/classes/lazy-base.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyBase description: CDKTN Core API Reference for LazyBase in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IResolvable diff --git a/content/api-reference/python/classes/lazy.mdx b/content/api-reference/python/classes/lazy.mdx index 0fbaa78..fa61774 100644 --- a/content/api-reference/python/classes/lazy.mdx +++ b/content/api-reference/python/classes/lazy.mdx @@ -4,7 +4,7 @@ sidebarTitle: Lazy description: CDKTN Core API Reference for Lazy in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Lazily produce a value. diff --git a/content/api-reference/python/classes/list-terraform-iterator.mdx b/content/api-reference/python/classes/list-terraform-iterator.mdx index be80365..15f0dba 100644 --- a/content/api-reference/python/classes/list-terraform-iterator.mdx +++ b/content/api-reference/python/classes/list-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ListTerraformIterator description: CDKTN Core API Reference for ListTerraformIterator in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/manifest.mdx b/content/api-reference/python/classes/manifest.mdx index 876f20e..57d399a 100644 --- a/content/api-reference/python/classes/manifest.mdx +++ b/content/api-reference/python/classes/manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: Manifest description: CDKTN Core API Reference for Manifest in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IManifest diff --git a/content/api-reference/python/classes/map-list.mdx b/content/api-reference/python/classes/map-list.mdx index 1313296..7e6c2fe 100644 --- a/content/api-reference/python/classes/map-list.mdx +++ b/content/api-reference/python/classes/map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: MapList description: CDKTN Core API Reference for MapList in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IInterpolatingParent, IResolvable diff --git a/content/api-reference/python/classes/map-terraform-iterator.mdx b/content/api-reference/python/classes/map-terraform-iterator.mdx index 5b87038..10e691b 100644 --- a/content/api-reference/python/classes/map-terraform-iterator.mdx +++ b/content/api-reference/python/classes/map-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: MapTerraformIterator description: CDKTN Core API Reference for MapTerraformIterator in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/migrate-ids.mdx b/content/api-reference/python/classes/migrate-ids.mdx index de94e13..adb5dd1 100644 --- a/content/api-reference/python/classes/migrate-ids.mdx +++ b/content/api-reference/python/classes/migrate-ids.mdx @@ -4,7 +4,7 @@ sidebarTitle: MigrateIds description: CDKTN Core API Reference for MigrateIds in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IAspect diff --git a/content/api-reference/python/classes/named-cloud-workspace.mdx b/content/api-reference/python/classes/named-cloud-workspace.mdx index b35845d..cbe43c7 100644 --- a/content/api-reference/python/classes/named-cloud-workspace.mdx +++ b/content/api-reference/python/classes/named-cloud-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: NamedCloudWorkspace description: CDKTN Core API Reference for NamedCloudWorkspace in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The name of a single Terraform Cloud workspace. diff --git a/content/api-reference/python/classes/named-remote-workspace.mdx b/content/api-reference/python/classes/named-remote-workspace.mdx index 98bc65a..3dc22f7 100644 --- a/content/api-reference/python/classes/named-remote-workspace.mdx +++ b/content/api-reference/python/classes/named-remote-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: NamedRemoteWorkspace description: CDKTN Core API Reference for NamedRemoteWorkspace in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IRemoteWorkspace diff --git a/content/api-reference/python/classes/number-list-list.mdx b/content/api-reference/python/classes/number-list-list.mdx index ecabb66..1555d3d 100644 --- a/content/api-reference/python/classes/number-list-list.mdx +++ b/content/api-reference/python/classes/number-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberListList description: CDKTN Core API Reference for NumberListList in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/number-list-map.mdx b/content/api-reference/python/classes/number-list-map.mdx index 7e5c432..6806f19 100644 --- a/content/api-reference/python/classes/number-list-map.mdx +++ b/content/api-reference/python/classes/number-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberListMap description: CDKTN Core API Reference for NumberListMap in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/number-map-list.mdx b/content/api-reference/python/classes/number-map-list.mdx index a9c7762..e193c28 100644 --- a/content/api-reference/python/classes/number-map-list.mdx +++ b/content/api-reference/python/classes/number-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberMapList description: CDKTN Core API Reference for NumberMapList in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/number-map.mdx b/content/api-reference/python/classes/number-map.mdx index 58a7333..4ae6dbc 100644 --- a/content/api-reference/python/classes/number-map.mdx +++ b/content/api-reference/python/classes/number-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberMap description: CDKTN Core API Reference for NumberMap in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/python/classes/op.mdx b/content/api-reference/python/classes/op.mdx index aecaa13..0249254 100644 --- a/content/api-reference/python/classes/op.mdx +++ b/content/api-reference/python/classes/op.mdx @@ -4,7 +4,7 @@ sidebarTitle: Op description: CDKTN Core API Reference for Op in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} This class contains static functions for all arithmetical and logical operators in the Terraform configuration language. diff --git a/content/api-reference/python/classes/prefixed-remote-workspaces.mdx b/content/api-reference/python/classes/prefixed-remote-workspaces.mdx index b1b8302..3cb47f1 100644 --- a/content/api-reference/python/classes/prefixed-remote-workspaces.mdx +++ b/content/api-reference/python/classes/prefixed-remote-workspaces.mdx @@ -4,7 +4,7 @@ sidebarTitle: PrefixedRemoteWorkspaces description: CDKTN Core API Reference for PrefixedRemoteWorkspaces in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IRemoteWorkspace diff --git a/content/api-reference/python/classes/resource-terraform-iterator.mdx b/content/api-reference/python/classes/resource-terraform-iterator.mdx index 1ca8da5..5d25f53 100644 --- a/content/api-reference/python/classes/resource-terraform-iterator.mdx +++ b/content/api-reference/python/classes/resource-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ResourceTerraformIterator description: CDKTN Core API Reference for ResourceTerraformIterator in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/string-concat.mdx b/content/api-reference/python/classes/string-concat.mdx index 4efaab8..11a44d4 100644 --- a/content/api-reference/python/classes/string-concat.mdx +++ b/content/api-reference/python/classes/string-concat.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringConcat description: CDKTN Core API Reference for StringConcat in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IFragmentConcatenator diff --git a/content/api-reference/python/classes/string-list-list.mdx b/content/api-reference/python/classes/string-list-list.mdx index f7ac919..0e4b2c4 100644 --- a/content/api-reference/python/classes/string-list-list.mdx +++ b/content/api-reference/python/classes/string-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringListList description: CDKTN Core API Reference for StringListList in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/string-list-map.mdx b/content/api-reference/python/classes/string-list-map.mdx index 5493a3f..92fd260 100644 --- a/content/api-reference/python/classes/string-list-map.mdx +++ b/content/api-reference/python/classes/string-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringListMap description: CDKTN Core API Reference for StringListMap in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/string-map-list.mdx b/content/api-reference/python/classes/string-map-list.mdx index 2840ff0..5cfd72c 100644 --- a/content/api-reference/python/classes/string-map-list.mdx +++ b/content/api-reference/python/classes/string-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMapList description: CDKTN Core API Reference for StringMapList in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/string-map-map.mdx b/content/api-reference/python/classes/string-map-map.mdx index de4dc5f..3449a66 100644 --- a/content/api-reference/python/classes/string-map-map.mdx +++ b/content/api-reference/python/classes/string-map-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMapMap description: CDKTN Core API Reference for StringMapMap in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/python/classes/string-map.mdx b/content/api-reference/python/classes/string-map.mdx index 29477b0..aa49d0c 100644 --- a/content/api-reference/python/classes/string-map.mdx +++ b/content/api-reference/python/classes/string-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMap description: CDKTN Core API Reference for StringMap in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/python/classes/tagged-cloud-workspaces.mdx b/content/api-reference/python/classes/tagged-cloud-workspaces.mdx index a64e21f..9a8b82e 100644 --- a/content/api-reference/python/classes/tagged-cloud-workspaces.mdx +++ b/content/api-reference/python/classes/tagged-cloud-workspaces.mdx @@ -4,7 +4,7 @@ sidebarTitle: TaggedCloudWorkspaces description: CDKTN Core API Reference for TaggedCloudWorkspaces in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} A set of Terraform Cloud workspace tags. diff --git a/content/api-reference/python/classes/terraform-count.mdx b/content/api-reference/python/classes/terraform-count.mdx index 526c17a..844dbe8 100644 --- a/content/api-reference/python/classes/terraform-count.mdx +++ b/content/api-reference/python/classes/terraform-count.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformCount description: CDKTN Core API Reference for TerraformCount in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Iterator for the Terraform count property. diff --git a/content/api-reference/python/classes/terraform-iterator.mdx b/content/api-reference/python/classes/terraform-iterator.mdx index 49dade1..ad222a8 100644 --- a/content/api-reference/python/classes/terraform-iterator.mdx +++ b/content/api-reference/python/classes/terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformIterator description: CDKTN Core API Reference for TerraformIterator in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformIterator diff --git a/content/api-reference/python/classes/terraform-resource-targets.mdx b/content/api-reference/python/classes/terraform-resource-targets.mdx index 7c971a6..c70ec1b 100644 --- a/content/api-reference/python/classes/terraform-resource-targets.mdx +++ b/content/api-reference/python/classes/terraform-resource-targets.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceTargets description: CDKTN Core API Reference for TerraformResourceTargets in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/classes/terraform-self.mdx b/content/api-reference/python/classes/terraform-self.mdx index e4a58ea..bc423a2 100644 --- a/content/api-reference/python/classes/terraform-self.mdx +++ b/content/api-reference/python/classes/terraform-self.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformSelf description: CDKTN Core API Reference for TerraformSelf in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Expressions in connection blocks cannot refer to their parent resource by name. diff --git a/content/api-reference/python/classes/testing.mdx b/content/api-reference/python/classes/testing.mdx index b49df33..0e8db71 100644 --- a/content/api-reference/python/classes/testing.mdx +++ b/content/api-reference/python/classes/testing.mdx @@ -4,7 +4,7 @@ sidebarTitle: Testing description: CDKTN Core API Reference for Testing in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Testing utilities for cdktf applications. diff --git a/content/api-reference/python/classes/token.mdx b/content/api-reference/python/classes/token.mdx index cf13981..96882f5 100644 --- a/content/api-reference/python/classes/token.mdx +++ b/content/api-reference/python/classes/token.mdx @@ -4,7 +4,7 @@ sidebarTitle: Token description: CDKTN Core API Reference for Token in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Represents a special or lazily-evaluated value. diff --git a/content/api-reference/python/classes/tokenization.mdx b/content/api-reference/python/classes/tokenization.mdx index dd46cdd..13bf6f4 100644 --- a/content/api-reference/python/classes/tokenization.mdx +++ b/content/api-reference/python/classes/tokenization.mdx @@ -4,7 +4,7 @@ sidebarTitle: Tokenization description: CDKTN Core API Reference for Tokenization in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Less oft-needed functions to manipulate Tokens. diff --git a/content/api-reference/python/classes/tokenized-string-fragments.mdx b/content/api-reference/python/classes/tokenized-string-fragments.mdx index 8967320..a9425d3 100644 --- a/content/api-reference/python/classes/tokenized-string-fragments.mdx +++ b/content/api-reference/python/classes/tokenized-string-fragments.mdx @@ -4,7 +4,7 @@ sidebarTitle: TokenizedStringFragments description: CDKTN Core API Reference for TokenizedStringFragments in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Fragments of a concatenated string containing stringified Tokens. diff --git a/content/api-reference/python/classes/variable-type.mdx b/content/api-reference/python/classes/variable-type.mdx index ccd93a7..05dea4b 100644 --- a/content/api-reference/python/classes/variable-type.mdx +++ b/content/api-reference/python/classes/variable-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: VariableType description: CDKTN Core API Reference for VariableType in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/python/constructs/app.mdx b/content/api-reference/python/constructs/app.mdx index 8f91247..3443aaa 100644 --- a/content/api-reference/python/constructs/app.mdx +++ b/content/api-reference/python/constructs/app.mdx @@ -4,7 +4,7 @@ sidebarTitle: App description: CDKTN Core API Reference for App in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Represents a cdktn application. @@ -101,6 +101,7 @@ Whether to skip all validations during synthesis of the app. | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | cross\_stack\_reference | Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources. | | synth | Synthesizes all resources to the output directory. | @@ -114,6 +115,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `cross_stack_reference` ```python diff --git a/content/api-reference/python/constructs/azurerm-backend.mdx b/content/api-reference/python/constructs/azurerm-backend.mdx index 2dfc09d..2cc06cd 100644 --- a/content/api-reference/python/constructs/azurerm-backend.mdx +++ b/content/api-reference/python/constructs/azurerm-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: AzurermBackend description: CDKTN Core API Reference for AzurermBackend in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -341,6 +341,7 @@ must be set to true (which is the default). | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -359,6 +360,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/cloud-backend.mdx b/content/api-reference/python/constructs/cloud-backend.mdx index c51dc9b..4a2a423 100644 --- a/content/api-reference/python/constructs/cloud-backend.mdx +++ b/content/api-reference/python/constructs/cloud-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudBackend description: CDKTN Core API Reference for CloudBackend in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The Cloud Backend synthesizes a [cloud block](https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block). The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings. @@ -80,6 +80,7 @@ We recommend omitting the token from the configuration, and instead using terraf | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -98,6 +99,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/consul-backend.mdx b/content/api-reference/python/constructs/consul-backend.mdx index d43ea50..fa62c76 100644 --- a/content/api-reference/python/constructs/consul-backend.mdx +++ b/content/api-reference/python/constructs/consul-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: ConsulBackend description: CDKTN Core API Reference for ConsulBackend in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -154,6 +154,7 @@ SSL support can also be triggered by setting then environment variable CONSUL\_H | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -172,6 +173,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/cos-backend.mdx b/content/api-reference/python/constructs/cos-backend.mdx index d3c1fc3..6eb613d 100644 --- a/content/api-reference/python/constructs/cos-backend.mdx +++ b/content/api-reference/python/constructs/cos-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackend description: CDKTN Core API Reference for CosBackend in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -190,6 +190,7 @@ It supports environment variables TENCENTCLOUD\_SECURITY\_TOKEN. | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -208,6 +209,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/data-resource.mdx b/content/api-reference/python/constructs/data-resource.mdx index 5fed545..0e93fd1 100644 --- a/content/api-reference/python/constructs/data-resource.mdx +++ b/content/api-reference/python/constructs/data-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataResource description: CDKTN Core API Reference for DataResource in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The DataResource implements the standard resource lifecycle, but does not directly take any other actions. @@ -139,6 +139,7 @@ https://developer.hashicorp.com/terraform/language/resources/terraform-data#trig | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -174,6 +175,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/data-terraform-remote-state-azurerm.mdx b/content/api-reference/python/constructs/data-terraform-remote-state-azurerm.mdx index 02b6f5f..e801881 100644 --- a/content/api-reference/python/constructs/data-terraform-remote-state-azurerm.mdx +++ b/content/api-reference/python/constructs/data-terraform-remote-state-azurerm.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateAzurerm description: CDKTN Core API Reference for DataTerraformRemoteStateAzurerm in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -365,6 +365,7 @@ must be set to true (which is the default). | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -387,6 +388,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/data-terraform-remote-state-consul.mdx b/content/api-reference/python/constructs/data-terraform-remote-state-consul.mdx index bdb75c7..d665dba 100644 --- a/content/api-reference/python/constructs/data-terraform-remote-state-consul.mdx +++ b/content/api-reference/python/constructs/data-terraform-remote-state-consul.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConsul description: CDKTN Core API Reference for DataTerraformRemoteStateConsul in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -178,6 +178,7 @@ SSL support can also be triggered by setting then environment variable CONSUL\_H | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -200,6 +201,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/data-terraform-remote-state-cos.mdx b/content/api-reference/python/constructs/data-terraform-remote-state-cos.mdx index 5db0c03..9bb46d5 100644 --- a/content/api-reference/python/constructs/data-terraform-remote-state-cos.mdx +++ b/content/api-reference/python/constructs/data-terraform-remote-state-cos.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateCos description: CDKTN Core API Reference for DataTerraformRemoteStateCos in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -214,6 +214,7 @@ It supports environment variables TENCENTCLOUD\_SECURITY\_TOKEN. | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -236,6 +237,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/data-terraform-remote-state-gcs.mdx b/content/api-reference/python/constructs/data-terraform-remote-state-gcs.mdx index e8e3b2b..8c504a3 100644 --- a/content/api-reference/python/constructs/data-terraform-remote-state-gcs.mdx +++ b/content/api-reference/python/constructs/data-terraform-remote-state-gcs.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateGcs description: CDKTN Core API Reference for DataTerraformRemoteStateGcs in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -166,6 +166,7 @@ Named states for workspaces are stored in an object called < prefix >/< na | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -188,6 +189,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/data-terraform-remote-state-http.mdx b/content/api-reference/python/constructs/data-terraform-remote-state-http.mdx index fec6b1e..e87c237 100644 --- a/content/api-reference/python/constructs/data-terraform-remote-state-http.mdx +++ b/content/api-reference/python/constructs/data-terraform-remote-state-http.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateHttp description: CDKTN Core API Reference for DataTerraformRemoteStateHttp in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -225,6 +225,7 @@ Defaults to POST. | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -247,6 +248,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/data-terraform-remote-state-local.mdx b/content/api-reference/python/constructs/data-terraform-remote-state-local.mdx index aff7cd9..42f6020 100644 --- a/content/api-reference/python/constructs/data-terraform-remote-state-local.mdx +++ b/content/api-reference/python/constructs/data-terraform-remote-state-local.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateLocal description: CDKTN Core API Reference for DataTerraformRemoteStateLocal in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -78,6 +78,7 @@ Path where the state file is stored. | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -100,6 +101,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/data-terraform-remote-state-oss.mdx b/content/api-reference/python/constructs/data-terraform-remote-state-oss.mdx index ad16fe8..0e92e6e 100644 --- a/content/api-reference/python/constructs/data-terraform-remote-state-oss.mdx +++ b/content/api-reference/python/constructs/data-terraform-remote-state-oss.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateOss description: CDKTN Core API Reference for DataTerraformRemoteStateOss in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -285,6 +285,7 @@ The table must have a primary key named LockID of type String. | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -307,6 +308,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/data-terraform-remote-state-pg.mdx b/content/api-reference/python/constructs/data-terraform-remote-state-pg.mdx index c83068b..e8d7bcb 100644 --- a/content/api-reference/python/constructs/data-terraform-remote-state-pg.mdx +++ b/content/api-reference/python/constructs/data-terraform-remote-state-pg.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStatePg description: CDKTN Core API Reference for DataTerraformRemoteStatePg in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -121,6 +121,7 @@ Terraform won't try to create the table, this is useful when it has already been | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -143,6 +144,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/data-terraform-remote-state-s3.mdx b/content/api-reference/python/constructs/data-terraform-remote-state-s3.mdx index 2e39ff5..a4d1071 100644 --- a/content/api-reference/python/constructs/data-terraform-remote-state-s3.mdx +++ b/content/api-reference/python/constructs/data-terraform-remote-state-s3.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateS3 description: CDKTN Core API Reference for DataTerraformRemoteStateS3 in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -64,6 +64,7 @@ cdktn.DataTerraformRemoteStateS3( sts_region: str = None, token: str = None, use_legacy_workflow: bool = None, + use_lockfile: bool = None, use_path_style: bool = None, workspace_key_prefix: str = None ) @@ -123,6 +124,7 @@ cdktn.DataTerraformRemoteStateS3( | sts\_region | str | (Optional) AWS region for STS. | | token | str | (Optional) Multi-Factor Authentication (MFA) token. | | use\_legacy\_workflow | bool | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. | +| use\_lockfile | bool | (Optional) Whether to use a lockfile for locking the state file. | | use\_path\_style | bool | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). | | workspace\_key\_prefix | str | (Optional) Prefix applied to the state path inside the bucket. | @@ -283,7 +285,9 @@ This can also be sourced from the AWS\_DYNAMODB\_ENDPOINT environment variable. *** -### `dynamodb_table`Optional +### ~~`dynamodb_table`~~Optional + +- *Deprecated:* Use useLockfile instead, which uses S3 for locking - *Type:* str @@ -647,6 +651,21 @@ This behavior does not align with the authentication flow of the AWS CLI or SDK' *** +### `use_lockfile`Optional + +- *Type:* bool + +(Optional) Whether to use a lockfile for locking the state file. + +Defaults to false. +State locking is an opt-in feature of the S3 backend. +Locking can be enabled via S3 or DynamoDB (see dynamodbTable). However, DynamoDB-based locking +is deprecated and will be removed in a future minor version. To support migration from older +versions of Terraform that only support DynamoDB-based locking, the S3 (useLockfile) and DynamoDB +(dynamodbTable) arguments can be configured simultaneously. + +*** + ### `use_path_style`Optional - *Type:* bool @@ -670,6 +689,7 @@ This is only relevant when using a non-default workspace. Defaults to env: | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -692,6 +712,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/data-terraform-remote-state-swift.mdx b/content/api-reference/python/constructs/data-terraform-remote-state-swift.mdx index 784cc4f..5da9062 100644 --- a/content/api-reference/python/constructs/data-terraform-remote-state-swift.mdx +++ b/content/api-reference/python/constructs/data-terraform-remote-state-swift.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateSwift description: CDKTN Core API Reference for DataTerraformRemoteStateSwift in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -331,6 +331,7 @@ cdktn.DataTerraformRemoteStateSwift( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -353,6 +354,29 @@ def to_string() -> str Returns a string representation of this construct. +### ~~`with`~~ + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### ~~`add_override`~~ ```python diff --git a/content/api-reference/python/constructs/data-terraform-remote-state.mdx b/content/api-reference/python/constructs/data-terraform-remote-state.mdx index 7cf50c3..81b40d3 100644 --- a/content/api-reference/python/constructs/data-terraform-remote-state.mdx +++ b/content/api-reference/python/constructs/data-terraform-remote-state.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteState description: CDKTN Core API Reference for DataTerraformRemoteState in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -89,6 +89,7 @@ cdktn.DataTerraformRemoteState( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -111,6 +112,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/gcs-backend.mdx b/content/api-reference/python/constructs/gcs-backend.mdx index c7b2650..92a87a2 100644 --- a/content/api-reference/python/constructs/gcs-backend.mdx +++ b/content/api-reference/python/constructs/gcs-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: GcsBackend description: CDKTN Core API Reference for GcsBackend in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -142,6 +142,7 @@ Named states for workspaces are stored in an object called < prefix >/< na | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -160,6 +161,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/http-backend.mdx b/content/api-reference/python/constructs/http-backend.mdx index 245fb6e..87afcb0 100644 --- a/content/api-reference/python/constructs/http-backend.mdx +++ b/content/api-reference/python/constructs/http-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: HttpBackend description: CDKTN Core API Reference for HttpBackend in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -201,6 +201,7 @@ Defaults to POST. | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -219,6 +220,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/importable-resource.mdx b/content/api-reference/python/constructs/importable-resource.mdx index a017adb..3ac90f4 100644 --- a/content/api-reference/python/constructs/importable-resource.mdx +++ b/content/api-reference/python/constructs/importable-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: ImportableResource description: CDKTN Core API Reference for ImportableResource in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Class used to represent an importable resource. @@ -51,6 +51,7 @@ cdktn.ImportableResource( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -68,6 +69,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/local-backend.mdx b/content/api-reference/python/constructs/local-backend.mdx index e79a9fc..ea3ecd7 100644 --- a/content/api-reference/python/constructs/local-backend.mdx +++ b/content/api-reference/python/constructs/local-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalBackend description: CDKTN Core API Reference for LocalBackend in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -54,6 +54,7 @@ Path where the state file is stored. | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -72,6 +73,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/oss-backend.mdx b/content/api-reference/python/constructs/oss-backend.mdx index fa87c3f..9e91f66 100644 --- a/content/api-reference/python/constructs/oss-backend.mdx +++ b/content/api-reference/python/constructs/oss-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssBackend description: CDKTN Core API Reference for OssBackend in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -261,6 +261,7 @@ The table must have a primary key named LockID of type String. | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -279,6 +280,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/pg-backend.mdx b/content/api-reference/python/constructs/pg-backend.mdx index 85ba6b5..21df62f 100644 --- a/content/api-reference/python/constructs/pg-backend.mdx +++ b/content/api-reference/python/constructs/pg-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: PgBackend description: CDKTN Core API Reference for PgBackend in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -97,6 +97,7 @@ Terraform won't try to create the table, this is useful when it has already been | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -115,6 +116,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/remote-backend.mdx b/content/api-reference/python/constructs/remote-backend.mdx index 2aad8ba..76dc257 100644 --- a/content/api-reference/python/constructs/remote-backend.mdx +++ b/content/api-reference/python/constructs/remote-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteBackend description: CDKTN Core API Reference for RemoteBackend in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -65,6 +65,7 @@ cdktn.RemoteBackend( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -83,6 +84,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/resource.mdx b/content/api-reference/python/constructs/resource.mdx index 8da46a5..f402df4 100644 --- a/content/api-reference/python/constructs/resource.mdx +++ b/content/api-reference/python/constructs/resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: Resource description: CDKTN Core API Reference for Resource in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IResource @@ -45,6 +45,7 @@ cdktn.Resource( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | *** @@ -56,6 +57,29 @@ def to_string() -> str Returns a string representation of this construct. +### ~~`with`~~ + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ## Static Functions | **Name** | **Description** | diff --git a/content/api-reference/python/constructs/s3-backend.mdx b/content/api-reference/python/constructs/s3-backend.mdx index f400dbe..3f43632 100644 --- a/content/api-reference/python/constructs/s3-backend.mdx +++ b/content/api-reference/python/constructs/s3-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3Backend description: CDKTN Core API Reference for S3Backend in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -61,6 +61,7 @@ cdktn.S3Backend( sts_region: str = None, token: str = None, use_legacy_workflow: bool = None, + use_lockfile: bool = None, use_path_style: bool = None, workspace_key_prefix: str = None ) @@ -117,6 +118,7 @@ cdktn.S3Backend( | sts\_region | str | (Optional) AWS region for STS. | | token | str | (Optional) Multi-Factor Authentication (MFA) token. | | use\_legacy\_workflow | bool | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. | +| use\_lockfile | bool | (Optional) Whether to use a lockfile for locking the state file. | | use\_path\_style | bool | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). | | workspace\_key\_prefix | str | (Optional) Prefix applied to the state path inside the bucket. | @@ -259,7 +261,9 @@ This can also be sourced from the AWS\_DYNAMODB\_ENDPOINT environment variable. *** -### `dynamodb_table`Optional +### ~~`dynamodb_table`~~Optional + +- *Deprecated:* Use useLockfile instead, which uses S3 for locking - *Type:* str @@ -623,6 +627,21 @@ This behavior does not align with the authentication flow of the AWS CLI or SDK' *** +### `use_lockfile`Optional + +- *Type:* bool + +(Optional) Whether to use a lockfile for locking the state file. + +Defaults to false. +State locking is an opt-in feature of the S3 backend. +Locking can be enabled via S3 or DynamoDB (see dynamodbTable). However, DynamoDB-based locking +is deprecated and will be removed in a future minor version. To support migration from older +versions of Terraform that only support DynamoDB-based locking, the S3 (useLockfile) and DynamoDB +(dynamodbTable) arguments can be configured simultaneously. + +*** + ### `use_path_style`Optional - *Type:* bool @@ -646,6 +665,7 @@ This is only relevant when using a non-default workspace. Defaults to env: | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -664,6 +684,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/swift-backend.mdx b/content/api-reference/python/constructs/swift-backend.mdx index 8ef1638..e033c86 100644 --- a/content/api-reference/python/constructs/swift-backend.mdx +++ b/content/api-reference/python/constructs/swift-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: SwiftBackend description: CDKTN Core API Reference for SwiftBackend in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -303,6 +303,7 @@ cdktn.SwiftBackend( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -321,6 +322,29 @@ def to_string() -> str Returns a string representation of this construct. +### ~~`with`~~ + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### ~~`add_override`~~ ```python diff --git a/content/api-reference/python/constructs/terraform-asset.mdx b/content/api-reference/python/constructs/terraform-asset.mdx index 9b7e239..ece8374 100644 --- a/content/api-reference/python/constructs/terraform-asset.mdx +++ b/content/api-reference/python/constructs/terraform-asset.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformAsset description: CDKTN Core API Reference for TerraformAsset in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -65,6 +65,7 @@ cdktn.TerraformAsset( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | *** @@ -76,6 +77,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ## Static Functions | **Name** | **Description** | diff --git a/content/api-reference/python/constructs/terraform-backend.mdx b/content/api-reference/python/constructs/terraform-backend.mdx index 4c384e2..3c1fd88 100644 --- a/content/api-reference/python/constructs/terraform-backend.mdx +++ b/content/api-reference/python/constructs/terraform-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformBackend description: CDKTN Core API Reference for TerraformBackend in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -49,6 +49,7 @@ cdktn.TerraformBackend( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/terraform-data-source.mdx b/content/api-reference/python/constructs/terraform-data-source.mdx index b5a2a03..75fbf4a 100644 --- a/content/api-reference/python/constructs/terraform-data-source.mdx +++ b/content/api-reference/python/constructs/terraform-data-source.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformDataSource description: CDKTN Core API Reference for TerraformDataSource in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformResource, ITerraformDependable, IInterpolatingParent @@ -115,6 +115,7 @@ cdktn.TerraformDataSource( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -142,6 +143,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/terraform-element.mdx b/content/api-reference/python/constructs/terraform-element.mdx index 8cded9f..b8eade8 100644 --- a/content/api-reference/python/constructs/terraform-element.mdx +++ b/content/api-reference/python/constructs/terraform-element.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformElement description: CDKTN Core API Reference for TerraformElement in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -49,6 +49,7 @@ cdktn.TerraformElement( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -66,6 +67,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/terraform-hcl-module.mdx b/content/api-reference/python/constructs/terraform-hcl-module.mdx index 388474e..bbed01a 100644 --- a/content/api-reference/python/constructs/terraform-hcl-module.mdx +++ b/content/api-reference/python/constructs/terraform-hcl-module.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformHclModule description: CDKTN Core API Reference for TerraformHclModule in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -97,6 +97,7 @@ cdktn.TerraformHclModule( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -122,6 +123,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/terraform-local.mdx b/content/api-reference/python/constructs/terraform-local.mdx index fbe9c6a..8a0d942 100644 --- a/content/api-reference/python/constructs/terraform-local.mdx +++ b/content/api-reference/python/constructs/terraform-local.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformLocal description: CDKTN Core API Reference for TerraformLocal in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -51,6 +51,7 @@ cdktn.TerraformLocal( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -68,6 +69,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/terraform-module.mdx b/content/api-reference/python/constructs/terraform-module.mdx index 67fa50d..43f0ed8 100644 --- a/content/api-reference/python/constructs/terraform-module.mdx +++ b/content/api-reference/python/constructs/terraform-module.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModule description: CDKTN Core API Reference for TerraformModule in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformDependable @@ -100,6 +100,7 @@ cdktn.TerraformModule( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -120,6 +121,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/terraform-output.mdx b/content/api-reference/python/constructs/terraform-output.mdx index 8a9a999..4867ecc 100644 --- a/content/api-reference/python/constructs/terraform-output.mdx +++ b/content/api-reference/python/constructs/terraform-output.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformOutput description: CDKTN Core API Reference for TerraformOutput in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -92,6 +92,7 @@ If set to true the synthesized Terraform Output will be named after the `id` pas | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -109,6 +110,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/terraform-provider.mdx b/content/api-reference/python/constructs/terraform-provider.mdx index 76ad788..cf17c87 100644 --- a/content/api-reference/python/constructs/terraform-provider.mdx +++ b/content/api-reference/python/constructs/terraform-provider.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProvider description: CDKTN Core API Reference for TerraformProvider in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -65,6 +65,7 @@ cdktn.TerraformProvider( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -82,6 +83,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/terraform-remote-state.mdx b/content/api-reference/python/constructs/terraform-remote-state.mdx index a74c15e..6b1ac84 100644 --- a/content/api-reference/python/constructs/terraform-remote-state.mdx +++ b/content/api-reference/python/constructs/terraform-remote-state.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformRemoteState description: CDKTN Core API Reference for TerraformRemoteState in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -67,6 +67,7 @@ cdktn.TerraformRemoteState( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -89,6 +90,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/terraform-resource.mdx b/content/api-reference/python/constructs/terraform-resource.mdx index f2993e1..fb74bf1 100644 --- a/content/api-reference/python/constructs/terraform-resource.mdx +++ b/content/api-reference/python/constructs/terraform-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResource description: CDKTN Core API Reference for TerraformResource in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformResource, ITerraformDependable, IInterpolatingParent @@ -115,6 +115,7 @@ cdktn.TerraformResource( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -148,6 +149,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/constructs/terraform-stack.mdx b/content/api-reference/python/constructs/terraform-stack.mdx index 9709c11..dde6fdb 100644 --- a/content/api-reference/python/constructs/terraform-stack.mdx +++ b/content/api-reference/python/constructs/terraform-stack.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformStack description: CDKTN Core API Reference for TerraformStack in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -41,6 +41,7 @@ cdktn.TerraformStack( | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_dependency | *No description.* | | add\_override | *No description.* | | all\_providers | *No description.* | @@ -65,6 +66,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_dependency` ```python diff --git a/content/api-reference/python/constructs/terraform-variable.mdx b/content/api-reference/python/constructs/terraform-variable.mdx index 1eca26a..a6b3dba 100644 --- a/content/api-reference/python/constructs/terraform-variable.mdx +++ b/content/api-reference/python/constructs/terraform-variable.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariable description: CDKTN Core API Reference for TerraformVariable in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -117,6 +117,7 @@ Specify arbitrary custom validation rules for a particular variable using a vali | **Name** | **Description** | | --- | --- | | to\_string | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | add\_override | *No description.* | | override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. | | reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -137,6 +138,29 @@ def to_string() -> str Returns a string representation of this construct. +### `with` + +```python +def with( + mixins: *IMixin +) -> IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* \*constructs.IMixin + +The mixins to apply. + +*** + ### `add_override` ```python diff --git a/content/api-reference/python/enums/annotation-metadata-entry-type.mdx b/content/api-reference/python/enums/annotation-metadata-entry-type.mdx index 4b105e9..9c5276c 100644 --- a/content/api-reference/python/enums/annotation-metadata-entry-type.mdx +++ b/content/api-reference/python/enums/annotation-metadata-entry-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnnotationMetadataEntryType description: CDKTN Core API Reference for AnnotationMetadataEntryType in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Members diff --git a/content/api-reference/python/enums/asset-type.mdx b/content/api-reference/python/enums/asset-type.mdx index ef8b689..60299ec 100644 --- a/content/api-reference/python/enums/asset-type.mdx +++ b/content/api-reference/python/enums/asset-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: AssetType description: CDKTN Core API Reference for AssetType in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Members diff --git a/content/api-reference/python/protocols/i-any-producer.mdx b/content/api-reference/python/protocols/i-any-producer.mdx index 86d8be7..1a4a7d2 100644 --- a/content/api-reference/python/protocols/i-any-producer.mdx +++ b/content/api-reference/python/protocols/i-any-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IAnyProducer description: CDKTN Core API Reference for IAnyProducer in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IAnyProducer diff --git a/content/api-reference/python/protocols/i-aspect.mdx b/content/api-reference/python/protocols/i-aspect.mdx index 5fa5ed3..0eb7703 100644 --- a/content/api-reference/python/protocols/i-aspect.mdx +++ b/content/api-reference/python/protocols/i-aspect.mdx @@ -4,7 +4,7 @@ sidebarTitle: IAspect description: CDKTN Core API Reference for IAspect in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* MigrateIds, IAspect diff --git a/content/api-reference/python/protocols/i-fragment-concatenator.mdx b/content/api-reference/python/protocols/i-fragment-concatenator.mdx index c9c0e6a..9b25293 100644 --- a/content/api-reference/python/protocols/i-fragment-concatenator.mdx +++ b/content/api-reference/python/protocols/i-fragment-concatenator.mdx @@ -4,7 +4,7 @@ sidebarTitle: IFragmentConcatenator description: CDKTN Core API Reference for IFragmentConcatenator in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* StringConcat, IFragmentConcatenator diff --git a/content/api-reference/python/protocols/i-importable-config.mdx b/content/api-reference/python/protocols/i-importable-config.mdx index 8e040b7..e8a391f 100644 --- a/content/api-reference/python/protocols/i-importable-config.mdx +++ b/content/api-reference/python/protocols/i-importable-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: IImportableConfig description: CDKTN Core API Reference for IImportableConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IImportableConfig diff --git a/content/api-reference/python/protocols/i-interpolating-parent.mdx b/content/api-reference/python/protocols/i-interpolating-parent.mdx index 95cbae6..9bd5bfa 100644 --- a/content/api-reference/python/protocols/i-interpolating-parent.mdx +++ b/content/api-reference/python/protocols/i-interpolating-parent.mdx @@ -4,7 +4,7 @@ sidebarTitle: IInterpolatingParent description: CDKTN Core API Reference for IInterpolatingParent in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyMapList, BooleanMapList, ComplexComputedList, ComplexObject, DataResource, MapList, NumberMapList, StringMapList, TerraformDataSource, TerraformResource, IInterpolatingParent diff --git a/content/api-reference/python/protocols/i-list-producer.mdx b/content/api-reference/python/protocols/i-list-producer.mdx index 3b7bdd3..40d1124 100644 --- a/content/api-reference/python/protocols/i-list-producer.mdx +++ b/content/api-reference/python/protocols/i-list-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IListProducer description: CDKTN Core API Reference for IListProducer in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IListProducer diff --git a/content/api-reference/python/protocols/i-manifest.mdx b/content/api-reference/python/protocols/i-manifest.mdx index c0aa5ff..f2c5dbc 100644 --- a/content/api-reference/python/protocols/i-manifest.mdx +++ b/content/api-reference/python/protocols/i-manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: IManifest description: CDKTN Core API Reference for IManifest in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* Manifest, IManifest diff --git a/content/api-reference/python/protocols/i-number-producer.mdx b/content/api-reference/python/protocols/i-number-producer.mdx index d2c5d7b..9575264 100644 --- a/content/api-reference/python/protocols/i-number-producer.mdx +++ b/content/api-reference/python/protocols/i-number-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: INumberProducer description: CDKTN Core API Reference for INumberProducer in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* INumberProducer diff --git a/content/api-reference/python/protocols/i-post-processor.mdx b/content/api-reference/python/protocols/i-post-processor.mdx index 8518d33..6d6357c 100644 --- a/content/api-reference/python/protocols/i-post-processor.mdx +++ b/content/api-reference/python/protocols/i-post-processor.mdx @@ -4,7 +4,7 @@ sidebarTitle: IPostProcessor description: CDKTN Core API Reference for IPostProcessor in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IPostProcessor diff --git a/content/api-reference/python/protocols/i-remote-workspace.mdx b/content/api-reference/python/protocols/i-remote-workspace.mdx index 01bf69a..6cec316 100644 --- a/content/api-reference/python/protocols/i-remote-workspace.mdx +++ b/content/api-reference/python/protocols/i-remote-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: IRemoteWorkspace description: CDKTN Core API Reference for IRemoteWorkspace in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* NamedRemoteWorkspace, PrefixedRemoteWorkspaces, IRemoteWorkspace diff --git a/content/api-reference/python/protocols/i-resolvable.mdx b/content/api-reference/python/protocols/i-resolvable.mdx index 87f7d4a..23555f0 100644 --- a/content/api-reference/python/protocols/i-resolvable.mdx +++ b/content/api-reference/python/protocols/i-resolvable.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResolvable description: CDKTN Core API Reference for IResolvable in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyListList, AnyListMap, AnyMap, AnyMapList, BooleanList, BooleanListList, BooleanListMap, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, LazyBase, MapList, NumberListList, NumberListMap, NumberMap, NumberMapList, StringListList, StringListMap, StringMap, StringMapList, StringMapMap, IResolvable diff --git a/content/api-reference/python/protocols/i-resolve-context.mdx b/content/api-reference/python/protocols/i-resolve-context.mdx index 4daca94..1585245 100644 --- a/content/api-reference/python/protocols/i-resolve-context.mdx +++ b/content/api-reference/python/protocols/i-resolve-context.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResolveContext description: CDKTN Core API Reference for IResolveContext in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IResolveContext diff --git a/content/api-reference/python/protocols/i-resource-constructor.mdx b/content/api-reference/python/protocols/i-resource-constructor.mdx index 4063509..1d7b487 100644 --- a/content/api-reference/python/protocols/i-resource-constructor.mdx +++ b/content/api-reference/python/protocols/i-resource-constructor.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResourceConstructor description: CDKTN Core API Reference for IResourceConstructor in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IResourceConstructor diff --git a/content/api-reference/python/protocols/i-resource.mdx b/content/api-reference/python/protocols/i-resource.mdx index f877a3a..eb6c431 100644 --- a/content/api-reference/python/protocols/i-resource.mdx +++ b/content/api-reference/python/protocols/i-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResource description: CDKTN Core API Reference for IResource in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Extends:* constructs.IConstruct diff --git a/content/api-reference/python/protocols/i-scope-callback.mdx b/content/api-reference/python/protocols/i-scope-callback.mdx index 1cecc1b..6f39973 100644 --- a/content/api-reference/python/protocols/i-scope-callback.mdx +++ b/content/api-reference/python/protocols/i-scope-callback.mdx @@ -4,7 +4,7 @@ sidebarTitle: IScopeCallback description: CDKTN Core API Reference for IScopeCallback in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IScopeCallback diff --git a/content/api-reference/python/protocols/i-stack-synthesizer.mdx b/content/api-reference/python/protocols/i-stack-synthesizer.mdx index 35e2066..9e6a4a3 100644 --- a/content/api-reference/python/protocols/i-stack-synthesizer.mdx +++ b/content/api-reference/python/protocols/i-stack-synthesizer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IStackSynthesizer description: CDKTN Core API Reference for IStackSynthesizer in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IStackSynthesizer diff --git a/content/api-reference/python/protocols/i-string-producer.mdx b/content/api-reference/python/protocols/i-string-producer.mdx index a7d856b..f17b574 100644 --- a/content/api-reference/python/protocols/i-string-producer.mdx +++ b/content/api-reference/python/protocols/i-string-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IStringProducer description: CDKTN Core API Reference for IStringProducer in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IStringProducer diff --git a/content/api-reference/python/protocols/i-synthesis-session.mdx b/content/api-reference/python/protocols/i-synthesis-session.mdx index f78c4bc..c50683e 100644 --- a/content/api-reference/python/protocols/i-synthesis-session.mdx +++ b/content/api-reference/python/protocols/i-synthesis-session.mdx @@ -4,7 +4,7 @@ sidebarTitle: ISynthesisSession description: CDKTN Core API Reference for ISynthesisSession in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* ISynthesisSession diff --git a/content/api-reference/python/protocols/i-terraform-addressable.mdx b/content/api-reference/python/protocols/i-terraform-addressable.mdx index e8627b5..c64839d 100644 --- a/content/api-reference/python/protocols/i-terraform-addressable.mdx +++ b/content/api-reference/python/protocols/i-terraform-addressable.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformAddressable description: CDKTN Core API Reference for ITerraformAddressable in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyListList, AnyListMap, AnyMap, AnyMapList, BooleanList, BooleanListList, BooleanListMap, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, DataResource, DataTerraformRemoteState, DataTerraformRemoteStateAzurerm, DataTerraformRemoteStateConsul, DataTerraformRemoteStateCos, DataTerraformRemoteStateGcs, DataTerraformRemoteStateHttp, DataTerraformRemoteStateLocal, DataTerraformRemoteStateOss, DataTerraformRemoteStatePg, DataTerraformRemoteStateS3, DataTerraformRemoteStateSwift, MapList, NumberListList, NumberListMap, NumberMap, NumberMapList, StringListList, StringListMap, StringMap, StringMapList, StringMapMap, TerraformDataSource, TerraformHclModule, TerraformLocal, TerraformModule, TerraformRemoteState, TerraformResource, TerraformVariable, ITerraformAddressable, ITerraformDependable diff --git a/content/api-reference/python/protocols/i-terraform-dependable.mdx b/content/api-reference/python/protocols/i-terraform-dependable.mdx index 2e9cd21..40a0e58 100644 --- a/content/api-reference/python/protocols/i-terraform-dependable.mdx +++ b/content/api-reference/python/protocols/i-terraform-dependable.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformDependable description: CDKTN Core API Reference for ITerraformDependable in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Extends:* ITerraformAddressable diff --git a/content/api-reference/python/protocols/i-terraform-iterator.mdx b/content/api-reference/python/protocols/i-terraform-iterator.mdx index a2cf5ce..6b5bb06 100644 --- a/content/api-reference/python/protocols/i-terraform-iterator.mdx +++ b/content/api-reference/python/protocols/i-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformIterator description: CDKTN Core API Reference for ITerraformIterator in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DynamicListTerraformIterator, ListTerraformIterator, MapTerraformIterator, ResourceTerraformIterator, TerraformIterator, ITerraformIterator diff --git a/content/api-reference/python/protocols/i-terraform-resource.mdx b/content/api-reference/python/protocols/i-terraform-resource.mdx index 34eca8e..6bfbc17 100644 --- a/content/api-reference/python/protocols/i-terraform-resource.mdx +++ b/content/api-reference/python/protocols/i-terraform-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformResource description: CDKTN Core API Reference for ITerraformResource in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DataResource, TerraformDataSource, TerraformResource, ITerraformResource diff --git a/content/api-reference/python/protocols/i-token-mapper.mdx b/content/api-reference/python/protocols/i-token-mapper.mdx index e92693d..fd1844f 100644 --- a/content/api-reference/python/protocols/i-token-mapper.mdx +++ b/content/api-reference/python/protocols/i-token-mapper.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITokenMapper description: CDKTN Core API Reference for ITokenMapper in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* ITokenMapper diff --git a/content/api-reference/python/protocols/i-token-resolver.mdx b/content/api-reference/python/protocols/i-token-resolver.mdx index 72aba69..f892d2d 100644 --- a/content/api-reference/python/protocols/i-token-resolver.mdx +++ b/content/api-reference/python/protocols/i-token-resolver.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITokenResolver description: CDKTN Core API Reference for ITokenResolver in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DefaultTokenResolver, ITokenResolver diff --git a/content/api-reference/python/structs/app-config.mdx b/content/api-reference/python/structs/app-config.mdx index 937a539..9e283b5 100644 --- a/content/api-reference/python/structs/app-config.mdx +++ b/content/api-reference/python/structs/app-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: AppConfig description: CDKTN Core API Reference for AppConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/azurerm-backend-config.mdx b/content/api-reference/python/structs/azurerm-backend-config.mdx index 5c2c096..debbab4 100644 --- a/content/api-reference/python/structs/azurerm-backend-config.mdx +++ b/content/api-reference/python/structs/azurerm-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: AzurermBackendConfig description: CDKTN Core API Reference for AzurermBackendConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as a Blob with the given Key within the Blob Container within the Blob Storage Account. diff --git a/content/api-reference/python/structs/cloud-backend-config.mdx b/content/api-reference/python/structs/cloud-backend-config.mdx index ca4fb1f..f5d8d1a 100644 --- a/content/api-reference/python/structs/cloud-backend-config.mdx +++ b/content/api-reference/python/structs/cloud-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudBackendConfig description: CDKTN Core API Reference for CloudBackendConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The Cloud Backend synthesizes a [cloud block](https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block). The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings. diff --git a/content/api-reference/python/structs/consul-backend-config.mdx b/content/api-reference/python/structs/consul-backend-config.mdx index bfe0157..452cbe6 100644 --- a/content/api-reference/python/structs/consul-backend-config.mdx +++ b/content/api-reference/python/structs/consul-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: ConsulBackendConfig description: CDKTN Core API Reference for ConsulBackendConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state in the Consul KV store at a given path. This backend supports state locking. diff --git a/content/api-reference/python/structs/cos-backend-assume-role.mdx b/content/api-reference/python/structs/cos-backend-assume-role.mdx index decc84a..19ac030 100644 --- a/content/api-reference/python/structs/cos-backend-assume-role.mdx +++ b/content/api-reference/python/structs/cos-backend-assume-role.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackendAssumeRole description: CDKTN Core API Reference for CosBackendAssumeRole in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/cos-backend-config.mdx b/content/api-reference/python/structs/cos-backend-config.mdx index 5563120..9a805b7 100644 --- a/content/api-reference/python/structs/cos-backend-config.mdx +++ b/content/api-reference/python/structs/cos-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackendConfig description: CDKTN Core API Reference for CosBackendConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as an object in a configurable prefix in a given bucket on Tencent Cloud Object Storage (COS). diff --git a/content/api-reference/python/structs/data-config.mdx b/content/api-reference/python/structs/data-config.mdx index d033b3e..9f933ad 100644 --- a/content/api-reference/python/structs/data-config.mdx +++ b/content/api-reference/python/structs/data-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataConfig description: CDKTN Core API Reference for DataConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/data-terraform-remote-state-azurerm-config.mdx b/content/api-reference/python/structs/data-terraform-remote-state-azurerm-config.mdx index b643e5f..c5c64ad 100644 --- a/content/api-reference/python/structs/data-terraform-remote-state-azurerm-config.mdx +++ b/content/api-reference/python/structs/data-terraform-remote-state-azurerm-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateAzurermConfig description: CDKTN Core API Reference for DataTerraformRemoteStateAzurermConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/data-terraform-remote-state-config.mdx b/content/api-reference/python/structs/data-terraform-remote-state-config.mdx index 8206b9a..85d5945 100644 --- a/content/api-reference/python/structs/data-terraform-remote-state-config.mdx +++ b/content/api-reference/python/structs/data-terraform-remote-state-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConfig description: CDKTN Core API Reference for DataTerraformRemoteStateConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/data-terraform-remote-state-consul-config.mdx b/content/api-reference/python/structs/data-terraform-remote-state-consul-config.mdx index 308cd8f..c580e03 100644 --- a/content/api-reference/python/structs/data-terraform-remote-state-consul-config.mdx +++ b/content/api-reference/python/structs/data-terraform-remote-state-consul-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConsulConfig description: CDKTN Core API Reference for DataTerraformRemoteStateConsulConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/data-terraform-remote-state-cos-config.mdx b/content/api-reference/python/structs/data-terraform-remote-state-cos-config.mdx index 2286316..529f3c2 100644 --- a/content/api-reference/python/structs/data-terraform-remote-state-cos-config.mdx +++ b/content/api-reference/python/structs/data-terraform-remote-state-cos-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateCosConfig description: CDKTN Core API Reference for DataTerraformRemoteStateCosConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/data-terraform-remote-state-gcs-config.mdx b/content/api-reference/python/structs/data-terraform-remote-state-gcs-config.mdx index dd099f1..2fc415b 100644 --- a/content/api-reference/python/structs/data-terraform-remote-state-gcs-config.mdx +++ b/content/api-reference/python/structs/data-terraform-remote-state-gcs-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateGcsConfig description: CDKTN Core API Reference for DataTerraformRemoteStateGcsConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/data-terraform-remote-state-http-config.mdx b/content/api-reference/python/structs/data-terraform-remote-state-http-config.mdx index e85ed78..065cb81 100644 --- a/content/api-reference/python/structs/data-terraform-remote-state-http-config.mdx +++ b/content/api-reference/python/structs/data-terraform-remote-state-http-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateHttpConfig description: CDKTN Core API Reference for DataTerraformRemoteStateHttpConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/data-terraform-remote-state-local-config.mdx b/content/api-reference/python/structs/data-terraform-remote-state-local-config.mdx index 68bcd02..ad150c1 100644 --- a/content/api-reference/python/structs/data-terraform-remote-state-local-config.mdx +++ b/content/api-reference/python/structs/data-terraform-remote-state-local-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateLocalConfig description: CDKTN Core API Reference for DataTerraformRemoteStateLocalConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/data-terraform-remote-state-oss-config.mdx b/content/api-reference/python/structs/data-terraform-remote-state-oss-config.mdx index 0faf05c..4b3a161 100644 --- a/content/api-reference/python/structs/data-terraform-remote-state-oss-config.mdx +++ b/content/api-reference/python/structs/data-terraform-remote-state-oss-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateOssConfig description: CDKTN Core API Reference for DataTerraformRemoteStateOssConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/data-terraform-remote-state-pg-config.mdx b/content/api-reference/python/structs/data-terraform-remote-state-pg-config.mdx index 905c55d..1072bf5 100644 --- a/content/api-reference/python/structs/data-terraform-remote-state-pg-config.mdx +++ b/content/api-reference/python/structs/data-terraform-remote-state-pg-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStatePgConfig description: CDKTN Core API Reference for DataTerraformRemoteStatePgConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/data-terraform-remote-state-remote-config.mdx b/content/api-reference/python/structs/data-terraform-remote-state-remote-config.mdx index 3a63027..884ca43 100644 --- a/content/api-reference/python/structs/data-terraform-remote-state-remote-config.mdx +++ b/content/api-reference/python/structs/data-terraform-remote-state-remote-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateRemoteConfig description: CDKTN Core API Reference for DataTerraformRemoteStateRemoteConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/data-terraform-remote-state-s3-config.mdx b/content/api-reference/python/structs/data-terraform-remote-state-s3-config.mdx index a1332f2..e664439 100644 --- a/content/api-reference/python/structs/data-terraform-remote-state-s3-config.mdx +++ b/content/api-reference/python/structs/data-terraform-remote-state-s3-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateS3Config description: CDKTN Core API Reference for DataTerraformRemoteStateS3Config in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer @@ -62,6 +62,7 @@ cdktn.DataTerraformRemoteStateS3Config( sts_region: str = None, token: str = None, use_legacy_workflow: bool = None, + use_lockfile: bool = None, use_path_style: bool = None, workspace_key_prefix: str = None ) @@ -121,6 +122,7 @@ cdktn.DataTerraformRemoteStateS3Config( | sts\_region | str | (Optional) AWS region for STS. | | token | str | (Optional) Multi-Factor Authentication (MFA) token. | | use\_legacy\_workflow | bool | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. | +| use\_lockfile | bool | (Optional) Whether to use a lockfile for locking the state file. | | use\_path\_style | bool | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). | | workspace\_key\_prefix | str | (Optional) Prefix applied to the state path inside the bucket. | @@ -329,7 +331,9 @@ This can also be sourced from the AWS\_DYNAMODB\_ENDPOINT environment variable. *** -### `dynamodb_table`Optional +### ~~`dynamodb_table`~~Optional + +- *Deprecated:* Use useLockfile instead, which uses S3 for locking ```python dynamodb_table: str @@ -833,6 +837,25 @@ This behavior does not align with the authentication flow of the AWS CLI or SDK' *** +### `use_lockfile`Optional + +```python +use_lockfile: bool +``` + +- *Type:* bool + +(Optional) Whether to use a lockfile for locking the state file. + +Defaults to false. +State locking is an opt-in feature of the S3 backend. +Locking can be enabled via S3 or DynamoDB (see dynamodbTable). However, DynamoDB-based locking +is deprecated and will be removed in a future minor version. To support migration from older +versions of Terraform that only support DynamoDB-based locking, the S3 (useLockfile) and DynamoDB +(dynamodbTable) arguments can be configured simultaneously. + +*** + ### `use_path_style`Optional ```python diff --git a/content/api-reference/python/structs/data-terraform-remote-state-swift-config.mdx b/content/api-reference/python/structs/data-terraform-remote-state-swift-config.mdx index 22ce83e..ad318d5 100644 --- a/content/api-reference/python/structs/data-terraform-remote-state-swift-config.mdx +++ b/content/api-reference/python/structs/data-terraform-remote-state-swift-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateSwiftConfig description: CDKTN Core API Reference for DataTerraformRemoteStateSwiftConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/encoding-options.mdx b/content/api-reference/python/structs/encoding-options.mdx index 634582a..7f6c3bc 100644 --- a/content/api-reference/python/structs/encoding-options.mdx +++ b/content/api-reference/python/structs/encoding-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: EncodingOptions description: CDKTN Core API Reference for EncodingOptions in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Properties to string encodings. diff --git a/content/api-reference/python/structs/file-provisioner.mdx b/content/api-reference/python/structs/file-provisioner.mdx index 6a0e03f..9a915b0 100644 --- a/content/api-reference/python/structs/file-provisioner.mdx +++ b/content/api-reference/python/structs/file-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: FileProvisioner description: CDKTN Core API Reference for FileProvisioner in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The file provisioner copies files or directories from the machine running Terraform to the newly created resource. diff --git a/content/api-reference/python/structs/gcs-backend-config.mdx b/content/api-reference/python/structs/gcs-backend-config.mdx index 2a7c801..e419936 100644 --- a/content/api-reference/python/structs/gcs-backend-config.mdx +++ b/content/api-reference/python/structs/gcs-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: GcsBackendConfig description: CDKTN Core API Reference for GcsBackendConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as an object in a configurable prefix in a pre-existing bucket on Google Cloud Storage (GCS). diff --git a/content/api-reference/python/structs/http-backend-config.mdx b/content/api-reference/python/structs/http-backend-config.mdx index e7b7f2c..41893a7 100644 --- a/content/api-reference/python/structs/http-backend-config.mdx +++ b/content/api-reference/python/structs/http-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: HttpBackendConfig description: CDKTN Core API Reference for HttpBackendConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state using a simple REST client. diff --git a/content/api-reference/python/structs/lazy-any-value-options.mdx b/content/api-reference/python/structs/lazy-any-value-options.mdx index fd543ae..4000773 100644 --- a/content/api-reference/python/structs/lazy-any-value-options.mdx +++ b/content/api-reference/python/structs/lazy-any-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyAnyValueOptions description: CDKTN Core API Reference for LazyAnyValueOptions in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating lazy untyped tokens. diff --git a/content/api-reference/python/structs/lazy-list-value-options.mdx b/content/api-reference/python/structs/lazy-list-value-options.mdx index 7367760..d9b0475 100644 --- a/content/api-reference/python/structs/lazy-list-value-options.mdx +++ b/content/api-reference/python/structs/lazy-list-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyListValueOptions description: CDKTN Core API Reference for LazyListValueOptions in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating a lazy list token. diff --git a/content/api-reference/python/structs/lazy-string-value-options.mdx b/content/api-reference/python/structs/lazy-string-value-options.mdx index cd440b8..c273a21 100644 --- a/content/api-reference/python/structs/lazy-string-value-options.mdx +++ b/content/api-reference/python/structs/lazy-string-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyStringValueOptions description: CDKTN Core API Reference for LazyStringValueOptions in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating a lazy string token. diff --git a/content/api-reference/python/structs/local-backend-config.mdx b/content/api-reference/python/structs/local-backend-config.mdx index 4db6760..47fffa1 100644 --- a/content/api-reference/python/structs/local-backend-config.mdx +++ b/content/api-reference/python/structs/local-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalBackendConfig description: CDKTN Core API Reference for LocalBackendConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The local backend stores state on the local filesystem, locks that state using system APIs, and performs operations locally. diff --git a/content/api-reference/python/structs/local-exec-provisioner.mdx b/content/api-reference/python/structs/local-exec-provisioner.mdx index fe90a78..36c0c44 100644 --- a/content/api-reference/python/structs/local-exec-provisioner.mdx +++ b/content/api-reference/python/structs/local-exec-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalExecProvisioner description: CDKTN Core API Reference for LocalExecProvisioner in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The local-exec provisioner invokes a local executable after a resource is created. diff --git a/content/api-reference/python/structs/oss-assume-role.mdx b/content/api-reference/python/structs/oss-assume-role.mdx index 78db311..c5f5c16 100644 --- a/content/api-reference/python/structs/oss-assume-role.mdx +++ b/content/api-reference/python/structs/oss-assume-role.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssAssumeRole description: CDKTN Core API Reference for OssAssumeRole in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/oss-backend-config.mdx b/content/api-reference/python/structs/oss-backend-config.mdx index 8f3d590..1fbe1df 100644 --- a/content/api-reference/python/structs/oss-backend-config.mdx +++ b/content/api-reference/python/structs/oss-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssBackendConfig description: CDKTN Core API Reference for OssBackendConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/pg-backend-config.mdx b/content/api-reference/python/structs/pg-backend-config.mdx index 697de3b..bd11cf7 100644 --- a/content/api-reference/python/structs/pg-backend-config.mdx +++ b/content/api-reference/python/structs/pg-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: PgBackendConfig description: CDKTN Core API Reference for PgBackendConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/postcondition.mdx b/content/api-reference/python/structs/postcondition.mdx index 31d0c2f..a7a4477 100644 --- a/content/api-reference/python/structs/postcondition.mdx +++ b/content/api-reference/python/structs/postcondition.mdx @@ -4,7 +4,7 @@ sidebarTitle: Postcondition description: CDKTN Core API Reference for Postcondition in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Terraform checks a postcondition after evaluating the object it is associated with. diff --git a/content/api-reference/python/structs/precondition.mdx b/content/api-reference/python/structs/precondition.mdx index 9340509..08f665f 100644 --- a/content/api-reference/python/structs/precondition.mdx +++ b/content/api-reference/python/structs/precondition.mdx @@ -4,7 +4,7 @@ sidebarTitle: Precondition description: CDKTN Core API Reference for Precondition in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Terraform checks a precondition before evaluating the object it is associated with. diff --git a/content/api-reference/python/structs/remote-backend-config.mdx b/content/api-reference/python/structs/remote-backend-config.mdx index 6437b8d..c9acd0d 100644 --- a/content/api-reference/python/structs/remote-backend-config.mdx +++ b/content/api-reference/python/structs/remote-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteBackendConfig description: CDKTN Core API Reference for RemoteBackendConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/remote-exec-provisioner.mdx b/content/api-reference/python/structs/remote-exec-provisioner.mdx index 93e26bd..27d5831 100644 --- a/content/api-reference/python/structs/remote-exec-provisioner.mdx +++ b/content/api-reference/python/structs/remote-exec-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteExecProvisioner description: CDKTN Core API Reference for RemoteExecProvisioner in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The remote-exec provisioner invokes a script on a remote resource after it is created. diff --git a/content/api-reference/python/structs/resolve-options.mdx b/content/api-reference/python/structs/resolve-options.mdx index 85b10ab..b2a6110 100644 --- a/content/api-reference/python/structs/resolve-options.mdx +++ b/content/api-reference/python/structs/resolve-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: ResolveOptions description: CDKTN Core API Reference for ResolveOptions in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options to the resolve() operation. diff --git a/content/api-reference/python/structs/s3-backend-assume-role-config.mdx b/content/api-reference/python/structs/s3-backend-assume-role-config.mdx index 19ef696..bfcfc98 100644 --- a/content/api-reference/python/structs/s3-backend-assume-role-config.mdx +++ b/content/api-reference/python/structs/s3-backend-assume-role-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendAssumeRoleConfig description: CDKTN Core API Reference for S3BackendAssumeRoleConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/s3-backend-assume-role-with-web-identity-config.mdx b/content/api-reference/python/structs/s3-backend-assume-role-with-web-identity-config.mdx index ef265fa..e8d90ea 100644 --- a/content/api-reference/python/structs/s3-backend-assume-role-with-web-identity-config.mdx +++ b/content/api-reference/python/structs/s3-backend-assume-role-with-web-identity-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendAssumeRoleWithWebIdentityConfig description: CDKTN Core API Reference for S3BackendAssumeRoleWithWebIdentityConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/s3-backend-config.mdx b/content/api-reference/python/structs/s3-backend-config.mdx index 8b91603..88b2b43 100644 --- a/content/api-reference/python/structs/s3-backend-config.mdx +++ b/content/api-reference/python/structs/s3-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendConfig description: CDKTN Core API Reference for S3BackendConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as a given key in a given bucket on Amazon S3. @@ -76,6 +76,7 @@ cdktn.S3BackendConfig( sts_region: str = None, token: str = None, use_legacy_workflow: bool = None, + use_lockfile: bool = None, use_path_style: bool = None, workspace_key_prefix: str = None ) @@ -133,6 +134,7 @@ cdktn.S3BackendConfig( | sts\_region | str | (Optional) AWS region for STS. | | token | str | (Optional) Multi-Factor Authentication (MFA) token. | | use\_legacy\_workflow | bool | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. | +| use\_lockfile | bool | (Optional) Whether to use a lockfile for locking the state file. | | use\_path\_style | bool | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). | | workspace\_key\_prefix | str | (Optional) Prefix applied to the state path inside the bucket. | @@ -321,7 +323,9 @@ This can also be sourced from the AWS\_DYNAMODB\_ENDPOINT environment variable. *** -### `dynamodb_table`Optional +### ~~`dynamodb_table`~~Optional + +- *Deprecated:* Use useLockfile instead, which uses S3 for locking ```python dynamodb_table: str @@ -825,6 +829,25 @@ This behavior does not align with the authentication flow of the AWS CLI or SDK' *** +### `use_lockfile`Optional + +```python +use_lockfile: bool +``` + +- *Type:* bool + +(Optional) Whether to use a lockfile for locking the state file. + +Defaults to false. +State locking is an opt-in feature of the S3 backend. +Locking can be enabled via S3 or DynamoDB (see dynamodbTable). However, DynamoDB-based locking +is deprecated and will be removed in a future minor version. To support migration from older +versions of Terraform that only support DynamoDB-based locking, the S3 (useLockfile) and DynamoDB +(dynamodbTable) arguments can be configured simultaneously. + +*** + ### `use_path_style`Optional ```python diff --git a/content/api-reference/python/structs/s3-backend-endpoint-config.mdx b/content/api-reference/python/structs/s3-backend-endpoint-config.mdx index 407042b..54ee568 100644 --- a/content/api-reference/python/structs/s3-backend-endpoint-config.mdx +++ b/content/api-reference/python/structs/s3-backend-endpoint-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendEndpointConfig description: CDKTN Core API Reference for S3BackendEndpointConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/ssh-provisioner-connection.mdx b/content/api-reference/python/structs/ssh-provisioner-connection.mdx index 154078e..d9f18d7 100644 --- a/content/api-reference/python/structs/ssh-provisioner-connection.mdx +++ b/content/api-reference/python/structs/ssh-provisioner-connection.mdx @@ -4,7 +4,7 @@ sidebarTitle: SSHProvisionerConnection description: CDKTN Core API Reference for SSHProvisionerConnection in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect. diff --git a/content/api-reference/python/structs/stack-annotation.mdx b/content/api-reference/python/structs/stack-annotation.mdx index a85a3cc..0578411 100644 --- a/content/api-reference/python/structs/stack-annotation.mdx +++ b/content/api-reference/python/structs/stack-annotation.mdx @@ -4,7 +4,7 @@ sidebarTitle: StackAnnotation description: CDKTN Core API Reference for StackAnnotation in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/stack-manifest.mdx b/content/api-reference/python/structs/stack-manifest.mdx index 867dada..34b3384 100644 --- a/content/api-reference/python/structs/stack-manifest.mdx +++ b/content/api-reference/python/structs/stack-manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: StackManifest description: CDKTN Core API Reference for StackManifest in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/swift-backend-config.mdx b/content/api-reference/python/structs/swift-backend-config.mdx index 7a06405..e360202 100644 --- a/content/api-reference/python/structs/swift-backend-config.mdx +++ b/content/api-reference/python/structs/swift-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: SwiftBackendConfig description: CDKTN Core API Reference for SwiftBackendConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-asset-config.mdx b/content/api-reference/python/structs/terraform-asset-config.mdx index 32842e0..bbc7f10 100644 --- a/content/api-reference/python/structs/terraform-asset-config.mdx +++ b/content/api-reference/python/structs/terraform-asset-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformAssetConfig description: CDKTN Core API Reference for TerraformAssetConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-condition.mdx b/content/api-reference/python/structs/terraform-condition.mdx index 73f51bb..183c507 100644 --- a/content/api-reference/python/structs/terraform-condition.mdx +++ b/content/api-reference/python/structs/terraform-condition.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformCondition description: CDKTN Core API Reference for TerraformCondition in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-constructor.mdx b/content/api-reference/python/structs/terraform-constructor.mdx index 71d1d7b..9bbb9f7 100644 --- a/content/api-reference/python/structs/terraform-constructor.mdx +++ b/content/api-reference/python/structs/terraform-constructor.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformConstructor description: CDKTN Core API Reference for TerraformConstructor in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-element-metadata.mdx b/content/api-reference/python/structs/terraform-element-metadata.mdx index e223397..463f805 100644 --- a/content/api-reference/python/structs/terraform-element-metadata.mdx +++ b/content/api-reference/python/structs/terraform-element-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformElementMetadata description: CDKTN Core API Reference for TerraformElementMetadata in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-hcl-module-config.mdx b/content/api-reference/python/structs/terraform-hcl-module-config.mdx index 12e87cf..5dcaa19 100644 --- a/content/api-reference/python/structs/terraform-hcl-module-config.mdx +++ b/content/api-reference/python/structs/terraform-hcl-module-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformHclModuleConfig description: CDKTN Core API Reference for TerraformHclModuleConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-meta-arguments.mdx b/content/api-reference/python/structs/terraform-meta-arguments.mdx index 0b81048..2dd7656 100644 --- a/content/api-reference/python/structs/terraform-meta-arguments.mdx +++ b/content/api-reference/python/structs/terraform-meta-arguments.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformMetaArguments description: CDKTN Core API Reference for TerraformMetaArguments in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-module-config.mdx b/content/api-reference/python/structs/terraform-module-config.mdx index cb66d59..b6a3842 100644 --- a/content/api-reference/python/structs/terraform-module-config.mdx +++ b/content/api-reference/python/structs/terraform-module-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleConfig description: CDKTN Core API Reference for TerraformModuleConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-module-provider.mdx b/content/api-reference/python/structs/terraform-module-provider.mdx index dd9b839..5a077c3 100644 --- a/content/api-reference/python/structs/terraform-module-provider.mdx +++ b/content/api-reference/python/structs/terraform-module-provider.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleProvider description: CDKTN Core API Reference for TerraformModuleProvider in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-module-user-config.mdx b/content/api-reference/python/structs/terraform-module-user-config.mdx index 47bd006..7a3ce32 100644 --- a/content/api-reference/python/structs/terraform-module-user-config.mdx +++ b/content/api-reference/python/structs/terraform-module-user-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleUserConfig description: CDKTN Core API Reference for TerraformModuleUserConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-output-config.mdx b/content/api-reference/python/structs/terraform-output-config.mdx index 7f0c7a4..a13c83b 100644 --- a/content/api-reference/python/structs/terraform-output-config.mdx +++ b/content/api-reference/python/structs/terraform-output-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformOutputConfig description: CDKTN Core API Reference for TerraformOutputConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-provider-config.mdx b/content/api-reference/python/structs/terraform-provider-config.mdx index 0c55d1c..df3f960 100644 --- a/content/api-reference/python/structs/terraform-provider-config.mdx +++ b/content/api-reference/python/structs/terraform-provider-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProviderConfig description: CDKTN Core API Reference for TerraformProviderConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-provider-generator-metadata.mdx b/content/api-reference/python/structs/terraform-provider-generator-metadata.mdx index ad9e133..36812cf 100644 --- a/content/api-reference/python/structs/terraform-provider-generator-metadata.mdx +++ b/content/api-reference/python/structs/terraform-provider-generator-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProviderGeneratorMetadata description: CDKTN Core API Reference for TerraformProviderGeneratorMetadata in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-resource-config.mdx b/content/api-reference/python/structs/terraform-resource-config.mdx index 4308f20..902cae1 100644 --- a/content/api-reference/python/structs/terraform-resource-config.mdx +++ b/content/api-reference/python/structs/terraform-resource-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceConfig description: CDKTN Core API Reference for TerraformResourceConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-resource-import.mdx b/content/api-reference/python/structs/terraform-resource-import.mdx index 4c9203d..3a958ba 100644 --- a/content/api-reference/python/structs/terraform-resource-import.mdx +++ b/content/api-reference/python/structs/terraform-resource-import.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceImport description: CDKTN Core API Reference for TerraformResourceImport in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-resource-lifecycle.mdx b/content/api-reference/python/structs/terraform-resource-lifecycle.mdx index 146a66e..ef56f2d 100644 --- a/content/api-reference/python/structs/terraform-resource-lifecycle.mdx +++ b/content/api-reference/python/structs/terraform-resource-lifecycle.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceLifecycle description: CDKTN Core API Reference for TerraformResourceLifecycle in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-resource-move-by-id.mdx b/content/api-reference/python/structs/terraform-resource-move-by-id.mdx index 736af7d..88f0f90 100644 --- a/content/api-reference/python/structs/terraform-resource-move-by-id.mdx +++ b/content/api-reference/python/structs/terraform-resource-move-by-id.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceMoveById description: CDKTN Core API Reference for TerraformResourceMoveById in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-resource-move-by-target.mdx b/content/api-reference/python/structs/terraform-resource-move-by-target.mdx index a9f3773..1d48e4e 100644 --- a/content/api-reference/python/structs/terraform-resource-move-by-target.mdx +++ b/content/api-reference/python/structs/terraform-resource-move-by-target.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceMoveByTarget description: CDKTN Core API Reference for TerraformResourceMoveByTarget in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-stack-metadata.mdx b/content/api-reference/python/structs/terraform-stack-metadata.mdx index d7d59b2..41229dc 100644 --- a/content/api-reference/python/structs/terraform-stack-metadata.mdx +++ b/content/api-reference/python/structs/terraform-stack-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformStackMetadata description: CDKTN Core API Reference for TerraformStackMetadata in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-variable-config.mdx b/content/api-reference/python/structs/terraform-variable-config.mdx index 29afba4..d7fbe36 100644 --- a/content/api-reference/python/structs/terraform-variable-config.mdx +++ b/content/api-reference/python/structs/terraform-variable-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariableConfig description: CDKTN Core API Reference for TerraformVariableConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/terraform-variable-validation-config.mdx b/content/api-reference/python/structs/terraform-variable-validation-config.mdx index 367fe2c..9cbddc1 100644 --- a/content/api-reference/python/structs/terraform-variable-validation-config.mdx +++ b/content/api-reference/python/structs/terraform-variable-validation-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariableValidationConfig description: CDKTN Core API Reference for TerraformVariableValidationConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Add one or more validation blocks within the variable block to specify custom conditions. diff --git a/content/api-reference/python/structs/testing-app-config.mdx b/content/api-reference/python/structs/testing-app-config.mdx index 6db4f26..2a43d99 100644 --- a/content/api-reference/python/structs/testing-app-config.mdx +++ b/content/api-reference/python/structs/testing-app-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TestingAppConfig description: CDKTN Core API Reference for TestingAppConfig in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/python/structs/winrm-provisioner-connection.mdx b/content/api-reference/python/structs/winrm-provisioner-connection.mdx index e87202f..b6115ac 100644 --- a/content/api-reference/python/structs/winrm-provisioner-connection.mdx +++ b/content/api-reference/python/structs/winrm-provisioner-connection.mdx @@ -4,7 +4,7 @@ sidebarTitle: WinrmProvisionerConnection description: CDKTN Core API Reference for WinrmProvisionerConnection in Python. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect. diff --git a/content/api-reference/typescript/classes/annotations.mdx b/content/api-reference/typescript/classes/annotations.mdx index 0240280..57a2046 100644 --- a/content/api-reference/typescript/classes/annotations.mdx +++ b/content/api-reference/typescript/classes/annotations.mdx @@ -4,7 +4,7 @@ sidebarTitle: Annotations description: CDKTN Core API Reference for Annotations in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Includes API for attaching annotations such as warning messages to constructs. diff --git a/content/api-reference/typescript/classes/any-list-list.mdx b/content/api-reference/typescript/classes/any-list-list.mdx index 16229ac..62dc93e 100644 --- a/content/api-reference/typescript/classes/any-list-list.mdx +++ b/content/api-reference/typescript/classes/any-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyListList description: CDKTN Core API Reference for AnyListList in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/any-list-map.mdx b/content/api-reference/typescript/classes/any-list-map.mdx index aa5cce9..125a3a7 100644 --- a/content/api-reference/typescript/classes/any-list-map.mdx +++ b/content/api-reference/typescript/classes/any-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyListMap description: CDKTN Core API Reference for AnyListMap in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/any-map-list.mdx b/content/api-reference/typescript/classes/any-map-list.mdx index 90b0cb7..b9fc169 100644 --- a/content/api-reference/typescript/classes/any-map-list.mdx +++ b/content/api-reference/typescript/classes/any-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyMapList description: CDKTN Core API Reference for AnyMapList in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/any-map.mdx b/content/api-reference/typescript/classes/any-map.mdx index 76aafad..b8c0270 100644 --- a/content/api-reference/typescript/classes/any-map.mdx +++ b/content/api-reference/typescript/classes/any-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnyMap description: CDKTN Core API Reference for AnyMap in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/typescript/classes/aspects.mdx b/content/api-reference/typescript/classes/aspects.mdx index 622d733..d847e06 100644 --- a/content/api-reference/typescript/classes/aspects.mdx +++ b/content/api-reference/typescript/classes/aspects.mdx @@ -4,7 +4,7 @@ sidebarTitle: Aspects description: CDKTN Core API Reference for Aspects in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis. diff --git a/content/api-reference/typescript/classes/assertion-return.mdx b/content/api-reference/typescript/classes/assertion-return.mdx index fa5f782..57ff96b 100644 --- a/content/api-reference/typescript/classes/assertion-return.mdx +++ b/content/api-reference/typescript/classes/assertion-return.mdx @@ -4,7 +4,7 @@ sidebarTitle: AssertionReturn description: CDKTN Core API Reference for AssertionReturn in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Class representing the contents of a return by an assertion. diff --git a/content/api-reference/typescript/classes/boolean-list-list.mdx b/content/api-reference/typescript/classes/boolean-list-list.mdx index 210f4dd..c6b4597 100644 --- a/content/api-reference/typescript/classes/boolean-list-list.mdx +++ b/content/api-reference/typescript/classes/boolean-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanListList description: CDKTN Core API Reference for BooleanListList in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/boolean-list-map.mdx b/content/api-reference/typescript/classes/boolean-list-map.mdx index 5b3f518..fdc0d23 100644 --- a/content/api-reference/typescript/classes/boolean-list-map.mdx +++ b/content/api-reference/typescript/classes/boolean-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanListMap description: CDKTN Core API Reference for BooleanListMap in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/boolean-list.mdx b/content/api-reference/typescript/classes/boolean-list.mdx index b2c86a0..1c2f14e 100644 --- a/content/api-reference/typescript/classes/boolean-list.mdx +++ b/content/api-reference/typescript/classes/boolean-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanList description: CDKTN Core API Reference for BooleanList in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/boolean-map-list.mdx b/content/api-reference/typescript/classes/boolean-map-list.mdx index 648b87e..f16a8a0 100644 --- a/content/api-reference/typescript/classes/boolean-map-list.mdx +++ b/content/api-reference/typescript/classes/boolean-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanMapList description: CDKTN Core API Reference for BooleanMapList in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/boolean-map.mdx b/content/api-reference/typescript/classes/boolean-map.mdx index b4c291c..c408b26 100644 --- a/content/api-reference/typescript/classes/boolean-map.mdx +++ b/content/api-reference/typescript/classes/boolean-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: BooleanMap description: CDKTN Core API Reference for BooleanMap in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/typescript/classes/cloud-workspace.mdx b/content/api-reference/typescript/classes/cloud-workspace.mdx index a8239cd..8794f51 100644 --- a/content/api-reference/typescript/classes/cloud-workspace.mdx +++ b/content/api-reference/typescript/classes/cloud-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudWorkspace description: CDKTN Core API Reference for CloudWorkspace in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} A cloud workspace can either be a single named workspace, or a list of tagged workspaces. diff --git a/content/api-reference/typescript/classes/complex-computed-list.mdx b/content/api-reference/typescript/classes/complex-computed-list.mdx index 6323069..d911276 100644 --- a/content/api-reference/typescript/classes/complex-computed-list.mdx +++ b/content/api-reference/typescript/classes/complex-computed-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexComputedList description: CDKTN Core API Reference for ComplexComputedList in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IInterpolatingParent, IResolvable, ITerraformAddressable diff --git a/content/api-reference/typescript/classes/complex-list.mdx b/content/api-reference/typescript/classes/complex-list.mdx index 1fca497..f567b8e 100644 --- a/content/api-reference/typescript/classes/complex-list.mdx +++ b/content/api-reference/typescript/classes/complex-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexList description: CDKTN Core API Reference for ComplexList in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/typescript/classes/complex-map.mdx b/content/api-reference/typescript/classes/complex-map.mdx index 9b10603..b3e35f5 100644 --- a/content/api-reference/typescript/classes/complex-map.mdx +++ b/content/api-reference/typescript/classes/complex-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexMap description: CDKTN Core API Reference for ComplexMap in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/typescript/classes/complex-object.mdx b/content/api-reference/typescript/classes/complex-object.mdx index e284a1c..a6d0d3a 100644 --- a/content/api-reference/typescript/classes/complex-object.mdx +++ b/content/api-reference/typescript/classes/complex-object.mdx @@ -4,7 +4,7 @@ sidebarTitle: ComplexObject description: CDKTN Core API Reference for ComplexObject in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IInterpolatingParent, IResolvable, ITerraformAddressable diff --git a/content/api-reference/typescript/classes/default-token-resolver.mdx b/content/api-reference/typescript/classes/default-token-resolver.mdx index 33df246..96a41bf 100644 --- a/content/api-reference/typescript/classes/default-token-resolver.mdx +++ b/content/api-reference/typescript/classes/default-token-resolver.mdx @@ -4,7 +4,7 @@ sidebarTitle: DefaultTokenResolver description: CDKTN Core API Reference for DefaultTokenResolver in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITokenResolver diff --git a/content/api-reference/typescript/classes/dynamic-list-terraform-iterator.mdx b/content/api-reference/typescript/classes/dynamic-list-terraform-iterator.mdx index fb350ff..a339207 100644 --- a/content/api-reference/typescript/classes/dynamic-list-terraform-iterator.mdx +++ b/content/api-reference/typescript/classes/dynamic-list-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: DynamicListTerraformIterator description: CDKTN Core API Reference for DynamicListTerraformIterator in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/fn-generated.mdx b/content/api-reference/typescript/classes/fn-generated.mdx index 238608b..acf87ae 100644 --- a/content/api-reference/typescript/classes/fn-generated.mdx +++ b/content/api-reference/typescript/classes/fn-generated.mdx @@ -4,7 +4,7 @@ sidebarTitle: FnGenerated description: CDKTN Core API Reference for FnGenerated in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -29,6 +29,7 @@ new FnGenerated() | anytrue | [anytrue](https://developer.hashicorp.com/terraform/language/functions/anytrue) returns `true` if any element in a given collection is `true` or `"true"`. It also returns `false` if the collection is empty. | | base64decode | [base64decode](https://developer.hashicorp.com/terraform/language/functions/base64decode) takes a string containing a Base64 character sequence and returns the original string. | | base64encode | [base64encode](https://developer.hashicorp.com/terraform/language/functions/base64encode) applies Base64 encoding to a string. | +| base64gunzip | [base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. | | base64gzip | [base64gzip](https://developer.hashicorp.com/terraform/language/functions/base64gzip) compresses a string with gzip and then encodes the result in Base64 encoding. | | base64sha256 | [base64sha256](https://developer.hashicorp.com/terraform/language/functions/base64sha256) computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()` returns hexadecimal representation. | | base64sha512 | [base64sha512](https://developer.hashicorp.com/terraform/language/functions/base64sha512) computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha512("test"))` since `sha512()` returns hexadecimal representation. | @@ -37,6 +38,7 @@ new FnGenerated() | ceil | [ceil](https://developer.hashicorp.com/terraform/language/functions/ceil) returns the closest whole number that is greater than or equal to the given value, which may be a fraction. | | chomp | [chomp](https://developer.hashicorp.com/terraform/language/functions/chomp) removes newline characters at the end of a string. | | chunklist | [chunklist](https://developer.hashicorp.com/terraform/language/functions/chunklist) splits a single list into fixed-size chunks, returning a list of lists. | +| cidrcontains | [cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. | | cidrhost | [cidrhost](https://developer.hashicorp.com/terraform/language/functions/cidrhost) calculates a full host IP address for a given host number within a given IP network address prefix. | | cidrnetmask | [cidrnetmask](https://developer.hashicorp.com/terraform/language/functions/cidrnetmask) converts an IPv4 address prefix given in CIDR notation into a subnet mask address. | | cidrsubnet | [cidrsubnet](https://developer.hashicorp.com/terraform/language/functions/cidrsubnet) calculates a subnet address within given IP network address prefix. | @@ -46,11 +48,13 @@ new FnGenerated() | compact | [compact](https://developer.hashicorp.com/terraform/language/functions/compact) takes a list of strings and returns a new list with any empty string elements removed. | | concat | [concat](https://developer.hashicorp.com/terraform/language/functions/concat) takes two or more lists and combines them into a single list. | | contains | [contains](https://developer.hashicorp.com/terraform/language/functions/contains) determines whether a given list or set contains a given single value as one of its elements. | +| convert | [convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. | | csvdecode | [csvdecode](https://developer.hashicorp.com/terraform/language/functions/csvdecode) decodes a string containing CSV-formatted data and produces a list of maps representing that data. | | dirname | [dirname](https://developer.hashicorp.com/terraform/language/functions/dirname) takes a string containing a filesystem path and removes the last portion from it. | | distinct | [distinct](https://developer.hashicorp.com/terraform/language/functions/distinct) takes a list and returns a new list with any duplicate elements removed. | | element | [element](https://developer.hashicorp.com/terraform/language/functions/element) retrieves a single element from a list. | | endswith | [endswith](https://developer.hashicorp.com/terraform/language/functions/endswith) takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix. | +| ephemeralasnull | [ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. | | file | [file](https://developer.hashicorp.com/terraform/language/functions/file) reads the contents of a file at the given path and returns them as a string. | | filebase64 | [filebase64](https://developer.hashicorp.com/terraform/language/functions/filebase64) reads the contents of a file at the given path and returns them as a base64-encoded string. | | filebase64sha256 | [filebase64sha256](https://developer.hashicorp.com/terraform/language/functions/filebase64sha256) is a variant of `base64sha256` that hashes the contents of a given file rather than a literal string. | @@ -68,6 +72,7 @@ new FnGenerated() | formatlist | [formatlist](https://developer.hashicorp.com/terraform/language/functions/formatlist) produces a list of strings by formatting a number of other values according to a specification string. | | indent | [indent](https://developer.hashicorp.com/terraform/language/functions/indent) adds a given number of spaces to the beginnings of all but the first line in a given multi-line string. | | index | [index](https://developer.hashicorp.com/terraform/language/functions/index) finds the element index for a given value in a list. | +| issensitive | [issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. | | jsondecode | [jsondecode](https://developer.hashicorp.com/terraform/language/functions/jsondecode) interprets a given string as JSON, returning a representation of the result of decoding that string. | | jsonencode | [jsonencode](https://developer.hashicorp.com/terraform/language/functions/jsonencode) encodes a given value to a string using JSON syntax. | | keys | [keys](https://developer.hashicorp.com/terraform/language/functions/keys) takes a map and returns a list containing the keys from that map. | @@ -108,6 +113,7 @@ new FnGenerated() | substr | [substr](https://developer.hashicorp.com/terraform/language/functions/substr) extracts a substring from a given string by offset and (maximum) length. | | sum | [sum](https://developer.hashicorp.com/terraform/language/functions/sum) takes a list or set of numbers and returns the sum of those numbers. | | templatefile | [templatefile](https://developer.hashicorp.com/terraform/language/functions/templatefile) reads the file at the given path and renders its content as a template using a supplied set of template variables. | +| templatestring | [templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. | | textdecodebase64 | [textdecodebase64](https://developer.hashicorp.com/terraform/language/functions/textdecodebase64) function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding. | | textencodebase64 | [textencodebase64](https://developer.hashicorp.com/terraform/language/functions/textencodebase64) encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters. | | timeadd | [timeadd](https://developer.hashicorp.com/terraform/language/functions/timeadd) adds a duration to a timestamp, returning a new timestamp. | @@ -127,6 +133,7 @@ new FnGenerated() | trimsuffix | [trimsuffix](https://developer.hashicorp.com/terraform/language/functions/trimsuffix) removes the specified suffix from the end of the given string. | | try | [try](https://developer.hashicorp.com/terraform/language/functions/try) evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors. | | upper | [upper](https://developer.hashicorp.com/terraform/language/functions/upper) converts all cased letters in the given string to uppercase. | +| urldecode | [urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. | | urlencode | [urlencode](https://developer.hashicorp.com/terraform/language/functions/urlencode) applies URL encoding to a given string. | | uuid | [uuid](https://developer.hashicorp.com/terraform/language/functions/uuid) generates a unique identifier string. | | uuidv5 | [uuidv5](https://developer.hashicorp.com/terraform/language/functions/uuidv5) generates a *name-based* UUID, as described in [RFC 4122 section 4.3](https://tools.ietf.org/html/rfc4122#section-4.3), also known as a "version 5" UUID. | @@ -233,6 +240,22 @@ FnGenerated.base64encode(str: string) *** +### `base64gunzip` + +```typescript +import { FnGenerated } from 'cdktn' + +FnGenerated.base64gunzip(str: string) +``` + +[base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. + +#### `str`Required + +- *Type:* string + +*** + ### `base64gzip` ```typescript @@ -367,6 +390,28 @@ FnGenerated.chunklist(list: any[], size: number) *** +### `cidrcontains` + +```typescript +import { FnGenerated } from 'cdktn' + +FnGenerated.cidrcontains(containing_prefix: string, contained_ip_or_prefix: string) +``` + +[cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. + +#### `containing_prefix`Required + +- *Type:* string + +*** + +#### `contained_ip_or_prefix`Required + +- *Type:* string + +*** + ### `cidrhost` ```typescript @@ -541,6 +586,28 @@ FnGenerated.contains(list: any, value: any) *** +### `convert` + +```typescript +import { FnGenerated } from 'cdktn' + +FnGenerated.convert(value: any, type: any) +``` + +[convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. + +#### `value`Required + +- *Type:* any + +*** + +#### `type`Required + +- *Type:* any + +*** + ### `csvdecode` ```typescript @@ -633,6 +700,22 @@ FnGenerated.endswith(str: string, suffix: string) *** +### `ephemeralasnull` + +```typescript +import { FnGenerated } from 'cdktn' + +FnGenerated.ephemeralasnull(value: any) +``` + +[ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. + +#### `value`Required + +- *Type:* any + +*** + ### `file` ```typescript @@ -941,6 +1024,22 @@ FnGenerated.index(list: any, value: any) *** +### `issensitive` + +```typescript +import { FnGenerated } from 'cdktn' + +FnGenerated.issensitive(value: any) +``` + +[issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. + +#### `value`Required + +- *Type:* any + +*** + ### `jsondecode` ```typescript @@ -1701,6 +1800,28 @@ FnGenerated.templatefile(path: string, vars: any) *** +### `templatestring` + +```typescript +import { FnGenerated } from 'cdktn' + +FnGenerated.templatestring(template: string, vars: any) +``` + +[templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. + +#### `template`Required + +- *Type:* string + +*** + +#### `vars`Required + +- *Type:* any + +*** + ### `textdecodebase64` ```typescript @@ -2041,6 +2162,22 @@ FnGenerated.upper(str: string) *** +### `urldecode` + +```typescript +import { FnGenerated } from 'cdktn' + +FnGenerated.urldecode(str: string) +``` + +[urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. + +#### `str`Required + +- *Type:* string + +*** + ### `urlencode` ```typescript diff --git a/content/api-reference/typescript/classes/fn.mdx b/content/api-reference/typescript/classes/fn.mdx index 24b3106..eb94b67 100644 --- a/content/api-reference/typescript/classes/fn.mdx +++ b/content/api-reference/typescript/classes/fn.mdx @@ -4,7 +4,7 @@ sidebarTitle: Fn description: CDKTN Core API Reference for Fn in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -29,6 +29,7 @@ new Fn() | anytrue | [anytrue](https://developer.hashicorp.com/terraform/language/functions/anytrue) returns `true` if any element in a given collection is `true` or `"true"`. It also returns `false` if the collection is empty. | | base64decode | [base64decode](https://developer.hashicorp.com/terraform/language/functions/base64decode) takes a string containing a Base64 character sequence and returns the original string. | | base64encode | [base64encode](https://developer.hashicorp.com/terraform/language/functions/base64encode) applies Base64 encoding to a string. | +| base64gunzip | [base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. | | base64gzip | [base64gzip](https://developer.hashicorp.com/terraform/language/functions/base64gzip) compresses a string with gzip and then encodes the result in Base64 encoding. | | base64sha256 | [base64sha256](https://developer.hashicorp.com/terraform/language/functions/base64sha256) computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()` returns hexadecimal representation. | | base64sha512 | [base64sha512](https://developer.hashicorp.com/terraform/language/functions/base64sha512) computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha512("test"))` since `sha512()` returns hexadecimal representation. | @@ -37,6 +38,7 @@ new Fn() | ceil | [ceil](https://developer.hashicorp.com/terraform/language/functions/ceil) returns the closest whole number that is greater than or equal to the given value, which may be a fraction. | | chomp | [chomp](https://developer.hashicorp.com/terraform/language/functions/chomp) removes newline characters at the end of a string. | | chunklist | [chunklist](https://developer.hashicorp.com/terraform/language/functions/chunklist) splits a single list into fixed-size chunks, returning a list of lists. | +| cidrcontains | [cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. | | cidrhost | [cidrhost](https://developer.hashicorp.com/terraform/language/functions/cidrhost) calculates a full host IP address for a given host number within a given IP network address prefix. | | cidrnetmask | [cidrnetmask](https://developer.hashicorp.com/terraform/language/functions/cidrnetmask) converts an IPv4 address prefix given in CIDR notation into a subnet mask address. | | cidrsubnet | [cidrsubnet](https://developer.hashicorp.com/terraform/language/functions/cidrsubnet) calculates a subnet address within given IP network address prefix. | @@ -46,11 +48,13 @@ new Fn() | compact | [compact](https://developer.hashicorp.com/terraform/language/functions/compact) takes a list of strings and returns a new list with any empty string elements removed. | | concat | [concat](https://developer.hashicorp.com/terraform/language/functions/concat) takes two or more lists and combines them into a single list. | | contains | [contains](https://developer.hashicorp.com/terraform/language/functions/contains) determines whether a given list or set contains a given single value as one of its elements. | +| convert | [convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. | | csvdecode | [csvdecode](https://developer.hashicorp.com/terraform/language/functions/csvdecode) decodes a string containing CSV-formatted data and produces a list of maps representing that data. | | dirname | [dirname](https://developer.hashicorp.com/terraform/language/functions/dirname) takes a string containing a filesystem path and removes the last portion from it. | | distinct | [distinct](https://developer.hashicorp.com/terraform/language/functions/distinct) takes a list and returns a new list with any duplicate elements removed. | | element | [element](https://developer.hashicorp.com/terraform/language/functions/element) retrieves a single element from a list. | | endswith | [endswith](https://developer.hashicorp.com/terraform/language/functions/endswith) takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix. | +| ephemeralasnull | [ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. | | file | [file](https://developer.hashicorp.com/terraform/language/functions/file) reads the contents of a file at the given path and returns them as a string. | | filebase64 | [filebase64](https://developer.hashicorp.com/terraform/language/functions/filebase64) reads the contents of a file at the given path and returns them as a base64-encoded string. | | filebase64sha256 | [filebase64sha256](https://developer.hashicorp.com/terraform/language/functions/filebase64sha256) is a variant of `base64sha256` that hashes the contents of a given file rather than a literal string. | @@ -68,6 +72,7 @@ new Fn() | formatlist | [formatlist](https://developer.hashicorp.com/terraform/language/functions/formatlist) produces a list of strings by formatting a number of other values according to a specification string. | | indent | [indent](https://developer.hashicorp.com/terraform/language/functions/indent) adds a given number of spaces to the beginnings of all but the first line in a given multi-line string. | | index | [index](https://developer.hashicorp.com/terraform/language/functions/index) finds the element index for a given value in a list. | +| issensitive | [issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. | | jsondecode | [jsondecode](https://developer.hashicorp.com/terraform/language/functions/jsondecode) interprets a given string as JSON, returning a representation of the result of decoding that string. | | jsonencode | [jsonencode](https://developer.hashicorp.com/terraform/language/functions/jsonencode) encodes a given value to a string using JSON syntax. | | keys | [keys](https://developer.hashicorp.com/terraform/language/functions/keys) takes a map and returns a list containing the keys from that map. | @@ -108,6 +113,7 @@ new Fn() | substr | [substr](https://developer.hashicorp.com/terraform/language/functions/substr) extracts a substring from a given string by offset and (maximum) length. | | sum | [sum](https://developer.hashicorp.com/terraform/language/functions/sum) takes a list or set of numbers and returns the sum of those numbers. | | templatefile | [templatefile](https://developer.hashicorp.com/terraform/language/functions/templatefile) reads the file at the given path and renders its content as a template using a supplied set of template variables. | +| templatestring | [templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. | | textdecodebase64 | [textdecodebase64](https://developer.hashicorp.com/terraform/language/functions/textdecodebase64) function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding. | | textencodebase64 | [textencodebase64](https://developer.hashicorp.com/terraform/language/functions/textencodebase64) encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters. | | timeadd | [timeadd](https://developer.hashicorp.com/terraform/language/functions/timeadd) adds a duration to a timestamp, returning a new timestamp. | @@ -127,6 +133,7 @@ new Fn() | trimsuffix | [trimsuffix](https://developer.hashicorp.com/terraform/language/functions/trimsuffix) removes the specified suffix from the end of the given string. | | try | [try](https://developer.hashicorp.com/terraform/language/functions/try) evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors. | | upper | [upper](https://developer.hashicorp.com/terraform/language/functions/upper) converts all cased letters in the given string to uppercase. | +| urldecode | [urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. | | urlencode | [urlencode](https://developer.hashicorp.com/terraform/language/functions/urlencode) applies URL encoding to a given string. | | uuid | [uuid](https://developer.hashicorp.com/terraform/language/functions/uuid) generates a unique identifier string. | | uuidv5 | [uuidv5](https://developer.hashicorp.com/terraform/language/functions/uuidv5) generates a *name-based* UUID, as described in [RFC 4122 section 4.3](https://tools.ietf.org/html/rfc4122#section-4.3), also known as a "version 5" UUID. | @@ -240,6 +247,22 @@ Fn.base64encode(str: string) *** +### `base64gunzip` + +```typescript +import { Fn } from 'cdktn' + +Fn.base64gunzip(str: string) +``` + +[base64gunzip](https://opentofu.org/docs/language/functions/base64gunzip) decodes a Base64-encoded string and uncompresses the result with gzip. + +#### `str`Required + +- *Type:* string + +*** + ### `base64gzip` ```typescript @@ -374,6 +397,28 @@ Fn.chunklist(list: any[], size: number) *** +### `cidrcontains` + +```typescript +import { Fn } from 'cdktn' + +Fn.cidrcontains(containing_prefix: string, contained_ip_or_prefix: string) +``` + +[cidrcontains](https://opentofu.org/docs/language/functions/cidrcontains) determines whether a given IP address or an address prefix given in CIDR notation is within a given IP network address prefix. + +#### `containing_prefix`Required + +- *Type:* string + +*** + +#### `contained_ip_or_prefix`Required + +- *Type:* string + +*** + ### `cidrhost` ```typescript @@ -548,6 +593,28 @@ Fn.contains(list: any, value: any) *** +### `convert` + +```typescript +import { Fn } from 'cdktn' + +Fn.convert(value: any, type: any) +``` + +[convert](https://developer.hashicorp.com/terraform/language/functions/convert) converts a value to the given type constraint. + +#### `value`Required + +- *Type:* any + +*** + +#### `type`Required + +- *Type:* any + +*** + ### `csvdecode` ```typescript @@ -640,6 +707,22 @@ Fn.endswith(str: string, suffix: string) *** +### `ephemeralasnull` + +```typescript +import { Fn } from 'cdktn' + +Fn.ephemeralasnull(value: any) +``` + +[ephemeralasnull](https://developer.hashicorp.com/terraform/language/functions/ephemeralasnull) takes a value of any type and returns a similar value of the same type with any ephemeral values replaced with non-ephemeral null values and all non-ephemeral values preserved. + +#### `value`Required + +- *Type:* any + +*** + ### `file` ```typescript @@ -948,6 +1031,22 @@ Fn.index(list: any, value: any) *** +### `issensitive` + +```typescript +import { Fn } from 'cdktn' + +Fn.issensitive(value: any) +``` + +[issensitive](https://developer.hashicorp.com/terraform/language/functions/issensitive) takes a value and returns a boolean indicating if the value is sensitive. + +#### `value`Required + +- *Type:* any + +*** + ### `jsondecode` ```typescript @@ -1708,6 +1807,28 @@ Fn.templatefile(path: string, vars: any) *** +### `templatestring` + +```typescript +import { Fn } from 'cdktn' + +Fn.templatestring(template: string, vars: any) +``` + +[templatestring](https://developer.hashicorp.com/terraform/language/functions/templatestring) takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. + +#### `template`Required + +- *Type:* string + +*** + +#### `vars`Required + +- *Type:* any + +*** + ### `textdecodebase64` ```typescript @@ -2048,6 +2169,22 @@ Fn.upper(str: string) *** +### `urldecode` + +```typescript +import { Fn } from 'cdktn' + +Fn.urldecode(str: string) +``` + +[urldecode](https://opentofu.org/docs/language/functions/urldecode) applies URL decoding to a given encoded string. + +#### `str`Required + +- *Type:* string + +*** + ### `urlencode` ```typescript diff --git a/content/api-reference/typescript/classes/lazy-base.mdx b/content/api-reference/typescript/classes/lazy-base.mdx index 4f8e7d3..1b74d4e 100644 --- a/content/api-reference/typescript/classes/lazy-base.mdx +++ b/content/api-reference/typescript/classes/lazy-base.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyBase description: CDKTN Core API Reference for LazyBase in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IResolvable diff --git a/content/api-reference/typescript/classes/lazy.mdx b/content/api-reference/typescript/classes/lazy.mdx index 6bf366a..4acbe56 100644 --- a/content/api-reference/typescript/classes/lazy.mdx +++ b/content/api-reference/typescript/classes/lazy.mdx @@ -4,7 +4,7 @@ sidebarTitle: Lazy description: CDKTN Core API Reference for Lazy in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Lazily produce a value. diff --git a/content/api-reference/typescript/classes/list-terraform-iterator.mdx b/content/api-reference/typescript/classes/list-terraform-iterator.mdx index 2732e1e..1c68bdb 100644 --- a/content/api-reference/typescript/classes/list-terraform-iterator.mdx +++ b/content/api-reference/typescript/classes/list-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ListTerraformIterator description: CDKTN Core API Reference for ListTerraformIterator in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/manifest.mdx b/content/api-reference/typescript/classes/manifest.mdx index 70101d7..512a47f 100644 --- a/content/api-reference/typescript/classes/manifest.mdx +++ b/content/api-reference/typescript/classes/manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: Manifest description: CDKTN Core API Reference for Manifest in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IManifest diff --git a/content/api-reference/typescript/classes/map-list.mdx b/content/api-reference/typescript/classes/map-list.mdx index 2eb41b8..8affda7 100644 --- a/content/api-reference/typescript/classes/map-list.mdx +++ b/content/api-reference/typescript/classes/map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: MapList description: CDKTN Core API Reference for MapList in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IInterpolatingParent, IResolvable diff --git a/content/api-reference/typescript/classes/map-terraform-iterator.mdx b/content/api-reference/typescript/classes/map-terraform-iterator.mdx index cab9931..db0dd8b 100644 --- a/content/api-reference/typescript/classes/map-terraform-iterator.mdx +++ b/content/api-reference/typescript/classes/map-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: MapTerraformIterator description: CDKTN Core API Reference for MapTerraformIterator in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/migrate-ids.mdx b/content/api-reference/typescript/classes/migrate-ids.mdx index e12f457..18c2c37 100644 --- a/content/api-reference/typescript/classes/migrate-ids.mdx +++ b/content/api-reference/typescript/classes/migrate-ids.mdx @@ -4,7 +4,7 @@ sidebarTitle: MigrateIds description: CDKTN Core API Reference for MigrateIds in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IAspect diff --git a/content/api-reference/typescript/classes/named-cloud-workspace.mdx b/content/api-reference/typescript/classes/named-cloud-workspace.mdx index e17829a..e677916 100644 --- a/content/api-reference/typescript/classes/named-cloud-workspace.mdx +++ b/content/api-reference/typescript/classes/named-cloud-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: NamedCloudWorkspace description: CDKTN Core API Reference for NamedCloudWorkspace in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The name of a single Terraform Cloud workspace. diff --git a/content/api-reference/typescript/classes/named-remote-workspace.mdx b/content/api-reference/typescript/classes/named-remote-workspace.mdx index 4a7cffa..9b57581 100644 --- a/content/api-reference/typescript/classes/named-remote-workspace.mdx +++ b/content/api-reference/typescript/classes/named-remote-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: NamedRemoteWorkspace description: CDKTN Core API Reference for NamedRemoteWorkspace in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IRemoteWorkspace diff --git a/content/api-reference/typescript/classes/number-list-list.mdx b/content/api-reference/typescript/classes/number-list-list.mdx index 0efc59e..b2810f4 100644 --- a/content/api-reference/typescript/classes/number-list-list.mdx +++ b/content/api-reference/typescript/classes/number-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberListList description: CDKTN Core API Reference for NumberListList in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/number-list-map.mdx b/content/api-reference/typescript/classes/number-list-map.mdx index 84cd8ef..8344e64 100644 --- a/content/api-reference/typescript/classes/number-list-map.mdx +++ b/content/api-reference/typescript/classes/number-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberListMap description: CDKTN Core API Reference for NumberListMap in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/number-map-list.mdx b/content/api-reference/typescript/classes/number-map-list.mdx index ccd5f3c..cfb8d53 100644 --- a/content/api-reference/typescript/classes/number-map-list.mdx +++ b/content/api-reference/typescript/classes/number-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberMapList description: CDKTN Core API Reference for NumberMapList in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/number-map.mdx b/content/api-reference/typescript/classes/number-map.mdx index 2c517ba..81121af 100644 --- a/content/api-reference/typescript/classes/number-map.mdx +++ b/content/api-reference/typescript/classes/number-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: NumberMap description: CDKTN Core API Reference for NumberMap in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/typescript/classes/op.mdx b/content/api-reference/typescript/classes/op.mdx index c48f2e2..a8e821b 100644 --- a/content/api-reference/typescript/classes/op.mdx +++ b/content/api-reference/typescript/classes/op.mdx @@ -4,7 +4,7 @@ sidebarTitle: Op description: CDKTN Core API Reference for Op in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} This class contains static functions for all arithmetical and logical operators in the Terraform configuration language. diff --git a/content/api-reference/typescript/classes/prefixed-remote-workspaces.mdx b/content/api-reference/typescript/classes/prefixed-remote-workspaces.mdx index 95fcb19..442c36f 100644 --- a/content/api-reference/typescript/classes/prefixed-remote-workspaces.mdx +++ b/content/api-reference/typescript/classes/prefixed-remote-workspaces.mdx @@ -4,7 +4,7 @@ sidebarTitle: PrefixedRemoteWorkspaces description: CDKTN Core API Reference for PrefixedRemoteWorkspaces in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IRemoteWorkspace diff --git a/content/api-reference/typescript/classes/resource-terraform-iterator.mdx b/content/api-reference/typescript/classes/resource-terraform-iterator.mdx index 9828547..e3a271f 100644 --- a/content/api-reference/typescript/classes/resource-terraform-iterator.mdx +++ b/content/api-reference/typescript/classes/resource-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ResourceTerraformIterator description: CDKTN Core API Reference for ResourceTerraformIterator in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/string-concat.mdx b/content/api-reference/typescript/classes/string-concat.mdx index ebb1585..3ea0392 100644 --- a/content/api-reference/typescript/classes/string-concat.mdx +++ b/content/api-reference/typescript/classes/string-concat.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringConcat description: CDKTN Core API Reference for StringConcat in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IFragmentConcatenator diff --git a/content/api-reference/typescript/classes/string-list-list.mdx b/content/api-reference/typescript/classes/string-list-list.mdx index 54ead34..b39534f 100644 --- a/content/api-reference/typescript/classes/string-list-list.mdx +++ b/content/api-reference/typescript/classes/string-list-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringListList description: CDKTN Core API Reference for StringListList in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/string-list-map.mdx b/content/api-reference/typescript/classes/string-list-map.mdx index b3ba26f..87c5fce 100644 --- a/content/api-reference/typescript/classes/string-list-map.mdx +++ b/content/api-reference/typescript/classes/string-list-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringListMap description: CDKTN Core API Reference for StringListMap in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/string-map-list.mdx b/content/api-reference/typescript/classes/string-map-list.mdx index 9b188ac..cede0dc 100644 --- a/content/api-reference/typescript/classes/string-map-list.mdx +++ b/content/api-reference/typescript/classes/string-map-list.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMapList description: CDKTN Core API Reference for StringMapList in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/string-map-map.mdx b/content/api-reference/typescript/classes/string-map-map.mdx index 2f7ff70..dc2737e 100644 --- a/content/api-reference/typescript/classes/string-map-map.mdx +++ b/content/api-reference/typescript/classes/string-map-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMapMap description: CDKTN Core API Reference for StringMapMap in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/typescript/classes/string-map.mdx b/content/api-reference/typescript/classes/string-map.mdx index bdeb585..f7b496d 100644 --- a/content/api-reference/typescript/classes/string-map.mdx +++ b/content/api-reference/typescript/classes/string-map.mdx @@ -4,7 +4,7 @@ sidebarTitle: StringMap description: CDKTN Core API Reference for StringMap in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable, IResolvable diff --git a/content/api-reference/typescript/classes/tagged-cloud-workspaces.mdx b/content/api-reference/typescript/classes/tagged-cloud-workspaces.mdx index 6f95b81..4ab7b08 100644 --- a/content/api-reference/typescript/classes/tagged-cloud-workspaces.mdx +++ b/content/api-reference/typescript/classes/tagged-cloud-workspaces.mdx @@ -4,7 +4,7 @@ sidebarTitle: TaggedCloudWorkspaces description: CDKTN Core API Reference for TaggedCloudWorkspaces in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} A set of Terraform Cloud workspace tags. diff --git a/content/api-reference/typescript/classes/terraform-count.mdx b/content/api-reference/typescript/classes/terraform-count.mdx index 117909e..f9f9ce4 100644 --- a/content/api-reference/typescript/classes/terraform-count.mdx +++ b/content/api-reference/typescript/classes/terraform-count.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformCount description: CDKTN Core API Reference for TerraformCount in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Iterator for the Terraform count property. diff --git a/content/api-reference/typescript/classes/terraform-iterator.mdx b/content/api-reference/typescript/classes/terraform-iterator.mdx index 0c5bf03..c2506f4 100644 --- a/content/api-reference/typescript/classes/terraform-iterator.mdx +++ b/content/api-reference/typescript/classes/terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformIterator description: CDKTN Core API Reference for TerraformIterator in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformIterator diff --git a/content/api-reference/typescript/classes/terraform-resource-targets.mdx b/content/api-reference/typescript/classes/terraform-resource-targets.mdx index 1fdb0c9..d0d55da 100644 --- a/content/api-reference/typescript/classes/terraform-resource-targets.mdx +++ b/content/api-reference/typescript/classes/terraform-resource-targets.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceTargets description: CDKTN Core API Reference for TerraformResourceTargets in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/classes/terraform-self.mdx b/content/api-reference/typescript/classes/terraform-self.mdx index fbb82fe..e86dfc6 100644 --- a/content/api-reference/typescript/classes/terraform-self.mdx +++ b/content/api-reference/typescript/classes/terraform-self.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformSelf description: CDKTN Core API Reference for TerraformSelf in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Expressions in connection blocks cannot refer to their parent resource by name. diff --git a/content/api-reference/typescript/classes/testing.mdx b/content/api-reference/typescript/classes/testing.mdx index 3e01749..5e3ba11 100644 --- a/content/api-reference/typescript/classes/testing.mdx +++ b/content/api-reference/typescript/classes/testing.mdx @@ -4,7 +4,7 @@ sidebarTitle: Testing description: CDKTN Core API Reference for Testing in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Testing utilities for cdktf applications. diff --git a/content/api-reference/typescript/classes/token.mdx b/content/api-reference/typescript/classes/token.mdx index 2004bee..c46a0cd 100644 --- a/content/api-reference/typescript/classes/token.mdx +++ b/content/api-reference/typescript/classes/token.mdx @@ -4,7 +4,7 @@ sidebarTitle: Token description: CDKTN Core API Reference for Token in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Represents a special or lazily-evaluated value. diff --git a/content/api-reference/typescript/classes/tokenization.mdx b/content/api-reference/typescript/classes/tokenization.mdx index 38a4b80..8936c82 100644 --- a/content/api-reference/typescript/classes/tokenization.mdx +++ b/content/api-reference/typescript/classes/tokenization.mdx @@ -4,7 +4,7 @@ sidebarTitle: Tokenization description: CDKTN Core API Reference for Tokenization in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Less oft-needed functions to manipulate Tokens. diff --git a/content/api-reference/typescript/classes/tokenized-string-fragments.mdx b/content/api-reference/typescript/classes/tokenized-string-fragments.mdx index fc819ea..cdb22d5 100644 --- a/content/api-reference/typescript/classes/tokenized-string-fragments.mdx +++ b/content/api-reference/typescript/classes/tokenized-string-fragments.mdx @@ -4,7 +4,7 @@ sidebarTitle: TokenizedStringFragments description: CDKTN Core API Reference for TokenizedStringFragments in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Fragments of a concatenated string containing stringified Tokens. diff --git a/content/api-reference/typescript/classes/variable-type.mdx b/content/api-reference/typescript/classes/variable-type.mdx index c14cc8b..fdd5a47 100644 --- a/content/api-reference/typescript/classes/variable-type.mdx +++ b/content/api-reference/typescript/classes/variable-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: VariableType description: CDKTN Core API Reference for VariableType in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers diff --git a/content/api-reference/typescript/constructs/app.mdx b/content/api-reference/typescript/constructs/app.mdx index 5ca3543..b4acd88 100644 --- a/content/api-reference/typescript/constructs/app.mdx +++ b/content/api-reference/typescript/constructs/app.mdx @@ -4,7 +4,7 @@ sidebarTitle: App description: CDKTN Core API Reference for App in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Represents a cdktn application. @@ -35,6 +35,7 @@ configuration. | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | crossStackReference | Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources. | | synth | Synthesizes all resources to the output directory. | @@ -48,6 +49,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `crossStackReference` ```typescript diff --git a/content/api-reference/typescript/constructs/azurerm-backend.mdx b/content/api-reference/typescript/constructs/azurerm-backend.mdx index b60036b..7216fd6 100644 --- a/content/api-reference/typescript/constructs/azurerm-backend.mdx +++ b/content/api-reference/typescript/constructs/azurerm-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: AzurermBackend description: CDKTN Core API Reference for AzurermBackend in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new AzurermBackend(scope: Construct, props: AzurermBackendConfig) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/cloud-backend.mdx b/content/api-reference/typescript/constructs/cloud-backend.mdx index b876896..5ae88bf 100644 --- a/content/api-reference/typescript/constructs/cloud-backend.mdx +++ b/content/api-reference/typescript/constructs/cloud-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudBackend description: CDKTN Core API Reference for CloudBackend in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The Cloud Backend synthesizes a [cloud block](https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block). The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings. @@ -40,6 +40,7 @@ new CloudBackend(scope: Construct, props: CloudBackendConfig) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -58,6 +59,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/consul-backend.mdx b/content/api-reference/typescript/constructs/consul-backend.mdx index f93aa47..e211115 100644 --- a/content/api-reference/typescript/constructs/consul-backend.mdx +++ b/content/api-reference/typescript/constructs/consul-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: ConsulBackend description: CDKTN Core API Reference for ConsulBackend in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new ConsulBackend(scope: Construct, props: ConsulBackendConfig) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/cos-backend.mdx b/content/api-reference/typescript/constructs/cos-backend.mdx index 48e6e5c..764ca83 100644 --- a/content/api-reference/typescript/constructs/cos-backend.mdx +++ b/content/api-reference/typescript/constructs/cos-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackend description: CDKTN Core API Reference for CosBackend in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new CosBackend(scope: Construct, props: CosBackendConfig) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/data-resource.mdx b/content/api-reference/typescript/constructs/data-resource.mdx index fe54c86..ac42225 100644 --- a/content/api-reference/typescript/constructs/data-resource.mdx +++ b/content/api-reference/typescript/constructs/data-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataResource description: CDKTN Core API Reference for DataResource in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The DataResource implements the standard resource lifecycle, but does not directly take any other actions. @@ -63,6 +63,7 @@ Must be unique amongst siblings in the same scope | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -98,6 +99,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/data-terraform-remote-state-azurerm.mdx b/content/api-reference/typescript/constructs/data-terraform-remote-state-azurerm.mdx index 9de0f57..d9858ca 100644 --- a/content/api-reference/typescript/constructs/data-terraform-remote-state-azurerm.mdx +++ b/content/api-reference/typescript/constructs/data-terraform-remote-state-azurerm.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateAzurerm description: CDKTN Core API Reference for DataTerraformRemoteStateAzurerm in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateAzurerm(scope: Construct, id: string, config: DataTe | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/data-terraform-remote-state-consul.mdx b/content/api-reference/typescript/constructs/data-terraform-remote-state-consul.mdx index ff87ff0..46f8fda 100644 --- a/content/api-reference/typescript/constructs/data-terraform-remote-state-consul.mdx +++ b/content/api-reference/typescript/constructs/data-terraform-remote-state-consul.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConsul description: CDKTN Core API Reference for DataTerraformRemoteStateConsul in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateConsul(scope: Construct, id: string, config: DataTer | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/data-terraform-remote-state-cos.mdx b/content/api-reference/typescript/constructs/data-terraform-remote-state-cos.mdx index 756cf80..0cb1983 100644 --- a/content/api-reference/typescript/constructs/data-terraform-remote-state-cos.mdx +++ b/content/api-reference/typescript/constructs/data-terraform-remote-state-cos.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateCos description: CDKTN Core API Reference for DataTerraformRemoteStateCos in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateCos(scope: Construct, id: string, config: DataTerraf | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/data-terraform-remote-state-gcs.mdx b/content/api-reference/typescript/constructs/data-terraform-remote-state-gcs.mdx index f059fac..55edd7f 100644 --- a/content/api-reference/typescript/constructs/data-terraform-remote-state-gcs.mdx +++ b/content/api-reference/typescript/constructs/data-terraform-remote-state-gcs.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateGcs description: CDKTN Core API Reference for DataTerraformRemoteStateGcs in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateGcs(scope: Construct, id: string, config: DataTerraf | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/data-terraform-remote-state-http.mdx b/content/api-reference/typescript/constructs/data-terraform-remote-state-http.mdx index c9c11bb..39df3ef 100644 --- a/content/api-reference/typescript/constructs/data-terraform-remote-state-http.mdx +++ b/content/api-reference/typescript/constructs/data-terraform-remote-state-http.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateHttp description: CDKTN Core API Reference for DataTerraformRemoteStateHttp in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateHttp(scope: Construct, id: string, config: DataTerra | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/data-terraform-remote-state-local.mdx b/content/api-reference/typescript/constructs/data-terraform-remote-state-local.mdx index 29ec30e..35a7324 100644 --- a/content/api-reference/typescript/constructs/data-terraform-remote-state-local.mdx +++ b/content/api-reference/typescript/constructs/data-terraform-remote-state-local.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateLocal description: CDKTN Core API Reference for DataTerraformRemoteStateLocal in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateLocal(scope: Construct, id: string, config: DataTerr | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/data-terraform-remote-state-oss.mdx b/content/api-reference/typescript/constructs/data-terraform-remote-state-oss.mdx index a8d2f18..d63f5cb 100644 --- a/content/api-reference/typescript/constructs/data-terraform-remote-state-oss.mdx +++ b/content/api-reference/typescript/constructs/data-terraform-remote-state-oss.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateOss description: CDKTN Core API Reference for DataTerraformRemoteStateOss in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateOss(scope: Construct, id: string, config: DataTerraf | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/data-terraform-remote-state-pg.mdx b/content/api-reference/typescript/constructs/data-terraform-remote-state-pg.mdx index 2255525..a63b97c 100644 --- a/content/api-reference/typescript/constructs/data-terraform-remote-state-pg.mdx +++ b/content/api-reference/typescript/constructs/data-terraform-remote-state-pg.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStatePg description: CDKTN Core API Reference for DataTerraformRemoteStatePg in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStatePg(scope: Construct, id: string, config: DataTerrafo | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/data-terraform-remote-state-s3.mdx b/content/api-reference/typescript/constructs/data-terraform-remote-state-s3.mdx index f3a24bf..a7cebe5 100644 --- a/content/api-reference/typescript/constructs/data-terraform-remote-state-s3.mdx +++ b/content/api-reference/typescript/constructs/data-terraform-remote-state-s3.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateS3 description: CDKTN Core API Reference for DataTerraformRemoteStateS3 in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateS3(scope: Construct, id: string, config: DataTerrafo | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/data-terraform-remote-state-swift.mdx b/content/api-reference/typescript/constructs/data-terraform-remote-state-swift.mdx index 177bab0..41ea4b9 100644 --- a/content/api-reference/typescript/constructs/data-terraform-remote-state-swift.mdx +++ b/content/api-reference/typescript/constructs/data-terraform-remote-state-swift.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateSwift description: CDKTN Core API Reference for DataTerraformRemoteStateSwift in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteStateSwift(scope: Construct, id: string, config: DataTerr | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ public toString(): string Returns a string representation of this construct. +### ~~`with`~~ + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### ~~`addOverride`~~ ```typescript diff --git a/content/api-reference/typescript/constructs/data-terraform-remote-state.mdx b/content/api-reference/typescript/constructs/data-terraform-remote-state.mdx index 9548374..5f967ad 100644 --- a/content/api-reference/typescript/constructs/data-terraform-remote-state.mdx +++ b/content/api-reference/typescript/constructs/data-terraform-remote-state.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteState description: CDKTN Core API Reference for DataTerraformRemoteState in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new DataTerraformRemoteState(scope: Construct, id: string, config: DataTerraform | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/gcs-backend.mdx b/content/api-reference/typescript/constructs/gcs-backend.mdx index 2b05076..53de677 100644 --- a/content/api-reference/typescript/constructs/gcs-backend.mdx +++ b/content/api-reference/typescript/constructs/gcs-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: GcsBackend description: CDKTN Core API Reference for GcsBackend in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new GcsBackend(scope: Construct, props: GcsBackendConfig) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/http-backend.mdx b/content/api-reference/typescript/constructs/http-backend.mdx index 64acf4d..3047188 100644 --- a/content/api-reference/typescript/constructs/http-backend.mdx +++ b/content/api-reference/typescript/constructs/http-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: HttpBackend description: CDKTN Core API Reference for HttpBackend in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new HttpBackend(scope: Construct, props: HttpBackendConfig) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/importable-resource.mdx b/content/api-reference/typescript/constructs/importable-resource.mdx index 3eca154..4761585 100644 --- a/content/api-reference/typescript/constructs/importable-resource.mdx +++ b/content/api-reference/typescript/constructs/importable-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: ImportableResource description: CDKTN Core API Reference for ImportableResource in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Class used to represent an importable resource. @@ -47,6 +47,7 @@ new ImportableResource(scope: Construct, name: string, config: IImportableConfig | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -64,6 +65,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/local-backend.mdx b/content/api-reference/typescript/constructs/local-backend.mdx index 3b2c9a0..e4fc160 100644 --- a/content/api-reference/typescript/constructs/local-backend.mdx +++ b/content/api-reference/typescript/constructs/local-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalBackend description: CDKTN Core API Reference for LocalBackend in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new LocalBackend(scope: Construct, props?: LocalBackendConfig) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/oss-backend.mdx b/content/api-reference/typescript/constructs/oss-backend.mdx index 1c61f14..c3cd4cf 100644 --- a/content/api-reference/typescript/constructs/oss-backend.mdx +++ b/content/api-reference/typescript/constructs/oss-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssBackend description: CDKTN Core API Reference for OssBackend in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new OssBackend(scope: Construct, props: OssBackendConfig) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/pg-backend.mdx b/content/api-reference/typescript/constructs/pg-backend.mdx index 2f512e3..e716b9a 100644 --- a/content/api-reference/typescript/constructs/pg-backend.mdx +++ b/content/api-reference/typescript/constructs/pg-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: PgBackend description: CDKTN Core API Reference for PgBackend in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new PgBackend(scope: Construct, props: PgBackendConfig) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/remote-backend.mdx b/content/api-reference/typescript/constructs/remote-backend.mdx index 09e0ee2..a29a3ea 100644 --- a/content/api-reference/typescript/constructs/remote-backend.mdx +++ b/content/api-reference/typescript/constructs/remote-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteBackend description: CDKTN Core API Reference for RemoteBackend in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new RemoteBackend(scope: Construct, props: RemoteBackendConfig) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/resource.mdx b/content/api-reference/typescript/constructs/resource.mdx index ae44031..f1b5c18 100644 --- a/content/api-reference/typescript/constructs/resource.mdx +++ b/content/api-reference/typescript/constructs/resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: Resource description: CDKTN Core API Reference for Resource in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* IResource @@ -42,6 +42,7 @@ new Resource(scope: Construct, id: string) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | *** @@ -53,6 +54,27 @@ public toString(): string Returns a string representation of this construct. +### ~~`with`~~ + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ## Static Functions | **Name** | **Description** | diff --git a/content/api-reference/typescript/constructs/s3-backend.mdx b/content/api-reference/typescript/constructs/s3-backend.mdx index 41a687f..1e1ba4e 100644 --- a/content/api-reference/typescript/constructs/s3-backend.mdx +++ b/content/api-reference/typescript/constructs/s3-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3Backend description: CDKTN Core API Reference for S3Backend in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new S3Backend(scope: Construct, props: S3BackendConfig) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/swift-backend.mdx b/content/api-reference/typescript/constructs/swift-backend.mdx index 6d323d2..bce2908 100644 --- a/content/api-reference/typescript/constructs/swift-backend.mdx +++ b/content/api-reference/typescript/constructs/swift-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: SwiftBackend description: CDKTN Core API Reference for SwiftBackend in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new SwiftBackend(scope: Construct, props: SwiftBackendConfig) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -56,6 +57,27 @@ public toString(): string Returns a string representation of this construct. +### ~~`with`~~ + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### ~~`addOverride`~~ ```typescript diff --git a/content/api-reference/typescript/constructs/terraform-asset.mdx b/content/api-reference/typescript/constructs/terraform-asset.mdx index e408283..9d428e3 100644 --- a/content/api-reference/typescript/constructs/terraform-asset.mdx +++ b/content/api-reference/typescript/constructs/terraform-asset.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformAsset description: CDKTN Core API Reference for TerraformAsset in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new TerraformAsset(scope: Construct, id: string, config: TerraformAssetConfig) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | *** @@ -56,6 +57,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ## Static Functions | **Name** | **Description** | diff --git a/content/api-reference/typescript/constructs/terraform-backend.mdx b/content/api-reference/typescript/constructs/terraform-backend.mdx index a779a77..3156185 100644 --- a/content/api-reference/typescript/constructs/terraform-backend.mdx +++ b/content/api-reference/typescript/constructs/terraform-backend.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformBackend description: CDKTN Core API Reference for TerraformBackend in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new TerraformBackend(scope: Construct, id: string, name: string) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -63,6 +64,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/terraform-data-source.mdx b/content/api-reference/typescript/constructs/terraform-data-source.mdx index 00952eb..099699b 100644 --- a/content/api-reference/typescript/constructs/terraform-data-source.mdx +++ b/content/api-reference/typescript/constructs/terraform-data-source.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformDataSource description: CDKTN Core API Reference for TerraformDataSource in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformResource, ITerraformDependable, IInterpolatingParent @@ -47,6 +47,7 @@ new TerraformDataSource(scope: Construct, id: string, config: TerraformResourceC | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -74,6 +75,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/terraform-element.mdx b/content/api-reference/typescript/constructs/terraform-element.mdx index a784b4c..a87fd19 100644 --- a/content/api-reference/typescript/constructs/terraform-element.mdx +++ b/content/api-reference/typescript/constructs/terraform-element.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformElement description: CDKTN Core API Reference for TerraformElement in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new TerraformElement(scope: Construct, id: string, elementType?: string) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -62,6 +63,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/terraform-hcl-module.mdx b/content/api-reference/typescript/constructs/terraform-hcl-module.mdx index e02a569..bb5531d 100644 --- a/content/api-reference/typescript/constructs/terraform-hcl-module.mdx +++ b/content/api-reference/typescript/constructs/terraform-hcl-module.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformHclModule description: CDKTN Core API Reference for TerraformHclModule in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new TerraformHclModule(scope: Construct, id: string, options: TerraformHclModule | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -70,6 +71,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/terraform-local.mdx b/content/api-reference/typescript/constructs/terraform-local.mdx index fee79da..5923ac0 100644 --- a/content/api-reference/typescript/constructs/terraform-local.mdx +++ b/content/api-reference/typescript/constructs/terraform-local.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformLocal description: CDKTN Core API Reference for TerraformLocal in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -47,6 +47,7 @@ new TerraformLocal(scope: Construct, id: string, expression: any) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -64,6 +65,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/terraform-module.mdx b/content/api-reference/typescript/constructs/terraform-module.mdx index 8280a09..4e2ee5b 100644 --- a/content/api-reference/typescript/constructs/terraform-module.mdx +++ b/content/api-reference/typescript/constructs/terraform-module.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModule description: CDKTN Core API Reference for TerraformModule in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformDependable @@ -56,6 +56,7 @@ new TerraformModule(scope: Construct, id: string, options: TerraformModuleConfig | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -76,6 +77,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/terraform-output.mdx b/content/api-reference/typescript/constructs/terraform-output.mdx index 0169aa1..e31fa7d 100644 --- a/content/api-reference/typescript/constructs/terraform-output.mdx +++ b/content/api-reference/typescript/constructs/terraform-output.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformOutput description: CDKTN Core API Reference for TerraformOutput in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new TerraformOutput(scope: Construct, id: string, config: TerraformOutputConfig) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -62,6 +63,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/terraform-provider.mdx b/content/api-reference/typescript/constructs/terraform-provider.mdx index 0d16c4b..8e7056f 100644 --- a/content/api-reference/typescript/constructs/terraform-provider.mdx +++ b/content/api-reference/typescript/constructs/terraform-provider.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProvider description: CDKTN Core API Reference for TerraformProvider in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -45,6 +45,7 @@ new TerraformProvider(scope: Construct, id: string, config: TerraformProviderCon | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -62,6 +63,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/terraform-remote-state.mdx b/content/api-reference/typescript/constructs/terraform-remote-state.mdx index a51028b..258d066 100644 --- a/content/api-reference/typescript/constructs/terraform-remote-state.mdx +++ b/content/api-reference/typescript/constructs/terraform-remote-state.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformRemoteState description: CDKTN Core API Reference for TerraformRemoteState in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -54,6 +54,7 @@ new TerraformRemoteState(scope: Construct, id: string, backend: string, config: | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -76,6 +77,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/terraform-resource.mdx b/content/api-reference/typescript/constructs/terraform-resource.mdx index 828107a..de93374 100644 --- a/content/api-reference/typescript/constructs/terraform-resource.mdx +++ b/content/api-reference/typescript/constructs/terraform-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResource description: CDKTN Core API Reference for TerraformResource in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformResource, ITerraformDependable, IInterpolatingParent @@ -47,6 +47,7 @@ new TerraformResource(scope: Construct, id: string, config: TerraformResourceCon | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -80,6 +81,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/constructs/terraform-stack.mdx b/content/api-reference/typescript/constructs/terraform-stack.mdx index d4b91ff..4837595 100644 --- a/content/api-reference/typescript/constructs/terraform-stack.mdx +++ b/content/api-reference/typescript/constructs/terraform-stack.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformStack description: CDKTN Core API Reference for TerraformStack in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializers @@ -38,6 +38,7 @@ new TerraformStack(scope: Construct, id: string) | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addDependency | *No description.* | | addOverride | *No description.* | | allProviders | *No description.* | @@ -62,6 +63,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addDependency` ```typescript diff --git a/content/api-reference/typescript/constructs/terraform-variable.mdx b/content/api-reference/typescript/constructs/terraform-variable.mdx index 0aec325..8adf687 100644 --- a/content/api-reference/typescript/constructs/terraform-variable.mdx +++ b/content/api-reference/typescript/constructs/terraform-variable.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariable description: CDKTN Core API Reference for TerraformVariable in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implements:* ITerraformAddressable @@ -47,6 +47,7 @@ new TerraformVariable(scope: Construct, id: string, config: TerraformVariableCon | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | +| with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | @@ -67,6 +68,27 @@ public toString(): string Returns a string representation of this construct. +### `with` + +```typescript +public with(mixins: ...IMixin[]): IConstruct +``` + +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. + +#### `mixins`Required + +- *Type:* ...constructs.IMixin\[] + +The mixins to apply. + +*** + ### `addOverride` ```typescript diff --git a/content/api-reference/typescript/enums/annotation-metadata-entry-type.mdx b/content/api-reference/typescript/enums/annotation-metadata-entry-type.mdx index f0522dd..714a5d8 100644 --- a/content/api-reference/typescript/enums/annotation-metadata-entry-type.mdx +++ b/content/api-reference/typescript/enums/annotation-metadata-entry-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: AnnotationMetadataEntryType description: CDKTN Core API Reference for AnnotationMetadataEntryType in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Members diff --git a/content/api-reference/typescript/enums/asset-type.mdx b/content/api-reference/typescript/enums/asset-type.mdx index 58da70c..2466e01 100644 --- a/content/api-reference/typescript/enums/asset-type.mdx +++ b/content/api-reference/typescript/enums/asset-type.mdx @@ -4,7 +4,7 @@ sidebarTitle: AssetType description: CDKTN Core API Reference for AssetType in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Members diff --git a/content/api-reference/typescript/protocols/i-any-producer.mdx b/content/api-reference/typescript/protocols/i-any-producer.mdx index 2f3fe23..ff2d3c6 100644 --- a/content/api-reference/typescript/protocols/i-any-producer.mdx +++ b/content/api-reference/typescript/protocols/i-any-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IAnyProducer description: CDKTN Core API Reference for IAnyProducer in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IAnyProducer diff --git a/content/api-reference/typescript/protocols/i-aspect.mdx b/content/api-reference/typescript/protocols/i-aspect.mdx index 450b98b..287309b 100644 --- a/content/api-reference/typescript/protocols/i-aspect.mdx +++ b/content/api-reference/typescript/protocols/i-aspect.mdx @@ -4,7 +4,7 @@ sidebarTitle: IAspect description: CDKTN Core API Reference for IAspect in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* MigrateIds, IAspect diff --git a/content/api-reference/typescript/protocols/i-fragment-concatenator.mdx b/content/api-reference/typescript/protocols/i-fragment-concatenator.mdx index 91dd65b..57b4f1a 100644 --- a/content/api-reference/typescript/protocols/i-fragment-concatenator.mdx +++ b/content/api-reference/typescript/protocols/i-fragment-concatenator.mdx @@ -4,7 +4,7 @@ sidebarTitle: IFragmentConcatenator description: CDKTN Core API Reference for IFragmentConcatenator in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* StringConcat, IFragmentConcatenator diff --git a/content/api-reference/typescript/protocols/i-importable-config.mdx b/content/api-reference/typescript/protocols/i-importable-config.mdx index f769f78..1d3da99 100644 --- a/content/api-reference/typescript/protocols/i-importable-config.mdx +++ b/content/api-reference/typescript/protocols/i-importable-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: IImportableConfig description: CDKTN Core API Reference for IImportableConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IImportableConfig diff --git a/content/api-reference/typescript/protocols/i-interpolating-parent.mdx b/content/api-reference/typescript/protocols/i-interpolating-parent.mdx index ac380d6..80390f5 100644 --- a/content/api-reference/typescript/protocols/i-interpolating-parent.mdx +++ b/content/api-reference/typescript/protocols/i-interpolating-parent.mdx @@ -4,7 +4,7 @@ sidebarTitle: IInterpolatingParent description: CDKTN Core API Reference for IInterpolatingParent in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyMapList, BooleanMapList, ComplexComputedList, ComplexObject, DataResource, MapList, NumberMapList, StringMapList, TerraformDataSource, TerraformResource, IInterpolatingParent diff --git a/content/api-reference/typescript/protocols/i-list-producer.mdx b/content/api-reference/typescript/protocols/i-list-producer.mdx index 2804019..e44f462 100644 --- a/content/api-reference/typescript/protocols/i-list-producer.mdx +++ b/content/api-reference/typescript/protocols/i-list-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IListProducer description: CDKTN Core API Reference for IListProducer in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IListProducer diff --git a/content/api-reference/typescript/protocols/i-manifest.mdx b/content/api-reference/typescript/protocols/i-manifest.mdx index 6b7df22..401a424 100644 --- a/content/api-reference/typescript/protocols/i-manifest.mdx +++ b/content/api-reference/typescript/protocols/i-manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: IManifest description: CDKTN Core API Reference for IManifest in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* Manifest, IManifest diff --git a/content/api-reference/typescript/protocols/i-number-producer.mdx b/content/api-reference/typescript/protocols/i-number-producer.mdx index 8e6320a..7e1ca4f 100644 --- a/content/api-reference/typescript/protocols/i-number-producer.mdx +++ b/content/api-reference/typescript/protocols/i-number-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: INumberProducer description: CDKTN Core API Reference for INumberProducer in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* INumberProducer diff --git a/content/api-reference/typescript/protocols/i-post-processor.mdx b/content/api-reference/typescript/protocols/i-post-processor.mdx index e15f5e8..1e8bf05 100644 --- a/content/api-reference/typescript/protocols/i-post-processor.mdx +++ b/content/api-reference/typescript/protocols/i-post-processor.mdx @@ -4,7 +4,7 @@ sidebarTitle: IPostProcessor description: CDKTN Core API Reference for IPostProcessor in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IPostProcessor diff --git a/content/api-reference/typescript/protocols/i-remote-workspace.mdx b/content/api-reference/typescript/protocols/i-remote-workspace.mdx index efd7d2f..c9892e0 100644 --- a/content/api-reference/typescript/protocols/i-remote-workspace.mdx +++ b/content/api-reference/typescript/protocols/i-remote-workspace.mdx @@ -4,7 +4,7 @@ sidebarTitle: IRemoteWorkspace description: CDKTN Core API Reference for IRemoteWorkspace in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* NamedRemoteWorkspace, PrefixedRemoteWorkspaces, IRemoteWorkspace diff --git a/content/api-reference/typescript/protocols/i-resolvable.mdx b/content/api-reference/typescript/protocols/i-resolvable.mdx index 4ae94f0..abe144d 100644 --- a/content/api-reference/typescript/protocols/i-resolvable.mdx +++ b/content/api-reference/typescript/protocols/i-resolvable.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResolvable description: CDKTN Core API Reference for IResolvable in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyListList, AnyListMap, AnyMap, AnyMapList, BooleanList, BooleanListList, BooleanListMap, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, LazyBase, MapList, NumberListList, NumberListMap, NumberMap, NumberMapList, StringListList, StringListMap, StringMap, StringMapList, StringMapMap, IResolvable diff --git a/content/api-reference/typescript/protocols/i-resolve-context.mdx b/content/api-reference/typescript/protocols/i-resolve-context.mdx index ef9bc5e..ca18fd3 100644 --- a/content/api-reference/typescript/protocols/i-resolve-context.mdx +++ b/content/api-reference/typescript/protocols/i-resolve-context.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResolveContext description: CDKTN Core API Reference for IResolveContext in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IResolveContext diff --git a/content/api-reference/typescript/protocols/i-resource-constructor.mdx b/content/api-reference/typescript/protocols/i-resource-constructor.mdx index 990f8e2..c033893 100644 --- a/content/api-reference/typescript/protocols/i-resource-constructor.mdx +++ b/content/api-reference/typescript/protocols/i-resource-constructor.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResourceConstructor description: CDKTN Core API Reference for IResourceConstructor in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IResourceConstructor diff --git a/content/api-reference/typescript/protocols/i-resource.mdx b/content/api-reference/typescript/protocols/i-resource.mdx index 609c61e..93cfb80 100644 --- a/content/api-reference/typescript/protocols/i-resource.mdx +++ b/content/api-reference/typescript/protocols/i-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: IResource description: CDKTN Core API Reference for IResource in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Extends:* constructs.IConstruct diff --git a/content/api-reference/typescript/protocols/i-scope-callback.mdx b/content/api-reference/typescript/protocols/i-scope-callback.mdx index ef03698..7282d2e 100644 --- a/content/api-reference/typescript/protocols/i-scope-callback.mdx +++ b/content/api-reference/typescript/protocols/i-scope-callback.mdx @@ -4,7 +4,7 @@ sidebarTitle: IScopeCallback description: CDKTN Core API Reference for IScopeCallback in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IScopeCallback diff --git a/content/api-reference/typescript/protocols/i-stack-synthesizer.mdx b/content/api-reference/typescript/protocols/i-stack-synthesizer.mdx index ebdee1a..54acd7c 100644 --- a/content/api-reference/typescript/protocols/i-stack-synthesizer.mdx +++ b/content/api-reference/typescript/protocols/i-stack-synthesizer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IStackSynthesizer description: CDKTN Core API Reference for IStackSynthesizer in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IStackSynthesizer diff --git a/content/api-reference/typescript/protocols/i-string-producer.mdx b/content/api-reference/typescript/protocols/i-string-producer.mdx index 766a26d..883fbb7 100644 --- a/content/api-reference/typescript/protocols/i-string-producer.mdx +++ b/content/api-reference/typescript/protocols/i-string-producer.mdx @@ -4,7 +4,7 @@ sidebarTitle: IStringProducer description: CDKTN Core API Reference for IStringProducer in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* IStringProducer diff --git a/content/api-reference/typescript/protocols/i-synthesis-session.mdx b/content/api-reference/typescript/protocols/i-synthesis-session.mdx index 883bfe3..524222b 100644 --- a/content/api-reference/typescript/protocols/i-synthesis-session.mdx +++ b/content/api-reference/typescript/protocols/i-synthesis-session.mdx @@ -4,7 +4,7 @@ sidebarTitle: ISynthesisSession description: CDKTN Core API Reference for ISynthesisSession in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* ISynthesisSession diff --git a/content/api-reference/typescript/protocols/i-terraform-addressable.mdx b/content/api-reference/typescript/protocols/i-terraform-addressable.mdx index 1f8e5c1..ecfe7eb 100644 --- a/content/api-reference/typescript/protocols/i-terraform-addressable.mdx +++ b/content/api-reference/typescript/protocols/i-terraform-addressable.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformAddressable description: CDKTN Core API Reference for ITerraformAddressable in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* AnyListList, AnyListMap, AnyMap, AnyMapList, BooleanList, BooleanListList, BooleanListMap, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, DataResource, DataTerraformRemoteState, DataTerraformRemoteStateAzurerm, DataTerraformRemoteStateConsul, DataTerraformRemoteStateCos, DataTerraformRemoteStateGcs, DataTerraformRemoteStateHttp, DataTerraformRemoteStateLocal, DataTerraformRemoteStateOss, DataTerraformRemoteStatePg, DataTerraformRemoteStateS3, DataTerraformRemoteStateSwift, MapList, NumberListList, NumberListMap, NumberMap, NumberMapList, StringListList, StringListMap, StringMap, StringMapList, StringMapMap, TerraformDataSource, TerraformHclModule, TerraformLocal, TerraformModule, TerraformRemoteState, TerraformResource, TerraformVariable, ITerraformAddressable, ITerraformDependable diff --git a/content/api-reference/typescript/protocols/i-terraform-dependable.mdx b/content/api-reference/typescript/protocols/i-terraform-dependable.mdx index df55446..866cc51 100644 --- a/content/api-reference/typescript/protocols/i-terraform-dependable.mdx +++ b/content/api-reference/typescript/protocols/i-terraform-dependable.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformDependable description: CDKTN Core API Reference for ITerraformDependable in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Extends:* ITerraformAddressable diff --git a/content/api-reference/typescript/protocols/i-terraform-iterator.mdx b/content/api-reference/typescript/protocols/i-terraform-iterator.mdx index a3c0f55..9015b0a 100644 --- a/content/api-reference/typescript/protocols/i-terraform-iterator.mdx +++ b/content/api-reference/typescript/protocols/i-terraform-iterator.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformIterator description: CDKTN Core API Reference for ITerraformIterator in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DynamicListTerraformIterator, ListTerraformIterator, MapTerraformIterator, ResourceTerraformIterator, TerraformIterator, ITerraformIterator diff --git a/content/api-reference/typescript/protocols/i-terraform-resource.mdx b/content/api-reference/typescript/protocols/i-terraform-resource.mdx index 1803ca0..f85411c 100644 --- a/content/api-reference/typescript/protocols/i-terraform-resource.mdx +++ b/content/api-reference/typescript/protocols/i-terraform-resource.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITerraformResource description: CDKTN Core API Reference for ITerraformResource in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DataResource, TerraformDataSource, TerraformResource, ITerraformResource diff --git a/content/api-reference/typescript/protocols/i-token-mapper.mdx b/content/api-reference/typescript/protocols/i-token-mapper.mdx index 0d684ac..05c1252 100644 --- a/content/api-reference/typescript/protocols/i-token-mapper.mdx +++ b/content/api-reference/typescript/protocols/i-token-mapper.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITokenMapper description: CDKTN Core API Reference for ITokenMapper in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* ITokenMapper diff --git a/content/api-reference/typescript/protocols/i-token-resolver.mdx b/content/api-reference/typescript/protocols/i-token-resolver.mdx index 1a95681..3f1d36c 100644 --- a/content/api-reference/typescript/protocols/i-token-resolver.mdx +++ b/content/api-reference/typescript/protocols/i-token-resolver.mdx @@ -4,7 +4,7 @@ sidebarTitle: ITokenResolver description: CDKTN Core API Reference for ITokenResolver in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} - *Implemented By:* DefaultTokenResolver, ITokenResolver diff --git a/content/api-reference/typescript/structs/app-config.mdx b/content/api-reference/typescript/structs/app-config.mdx index f28ffd0..d598ca5 100644 --- a/content/api-reference/typescript/structs/app-config.mdx +++ b/content/api-reference/typescript/structs/app-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: AppConfig description: CDKTN Core API Reference for AppConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/azurerm-backend-config.mdx b/content/api-reference/typescript/structs/azurerm-backend-config.mdx index ba53ab9..cc2c657 100644 --- a/content/api-reference/typescript/structs/azurerm-backend-config.mdx +++ b/content/api-reference/typescript/structs/azurerm-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: AzurermBackendConfig description: CDKTN Core API Reference for AzurermBackendConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as a Blob with the given Key within the Blob Container within the Blob Storage Account. diff --git a/content/api-reference/typescript/structs/cloud-backend-config.mdx b/content/api-reference/typescript/structs/cloud-backend-config.mdx index d5d6d3e..bf188fc 100644 --- a/content/api-reference/typescript/structs/cloud-backend-config.mdx +++ b/content/api-reference/typescript/structs/cloud-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: CloudBackendConfig description: CDKTN Core API Reference for CloudBackendConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The Cloud Backend synthesizes a [cloud block](https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block). The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings. diff --git a/content/api-reference/typescript/structs/consul-backend-config.mdx b/content/api-reference/typescript/structs/consul-backend-config.mdx index 61fb403..220605a 100644 --- a/content/api-reference/typescript/structs/consul-backend-config.mdx +++ b/content/api-reference/typescript/structs/consul-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: ConsulBackendConfig description: CDKTN Core API Reference for ConsulBackendConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state in the Consul KV store at a given path. This backend supports state locking. diff --git a/content/api-reference/typescript/structs/cos-backend-assume-role.mdx b/content/api-reference/typescript/structs/cos-backend-assume-role.mdx index a00c654..5ca7035 100644 --- a/content/api-reference/typescript/structs/cos-backend-assume-role.mdx +++ b/content/api-reference/typescript/structs/cos-backend-assume-role.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackendAssumeRole description: CDKTN Core API Reference for CosBackendAssumeRole in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/cos-backend-config.mdx b/content/api-reference/typescript/structs/cos-backend-config.mdx index 841af18..3c8015c 100644 --- a/content/api-reference/typescript/structs/cos-backend-config.mdx +++ b/content/api-reference/typescript/structs/cos-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: CosBackendConfig description: CDKTN Core API Reference for CosBackendConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as an object in a configurable prefix in a given bucket on Tencent Cloud Object Storage (COS). diff --git a/content/api-reference/typescript/structs/data-config.mdx b/content/api-reference/typescript/structs/data-config.mdx index 77767e8..fed0930 100644 --- a/content/api-reference/typescript/structs/data-config.mdx +++ b/content/api-reference/typescript/structs/data-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataConfig description: CDKTN Core API Reference for DataConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/data-terraform-remote-state-azurerm-config.mdx b/content/api-reference/typescript/structs/data-terraform-remote-state-azurerm-config.mdx index 83fc46e..5253ed4 100644 --- a/content/api-reference/typescript/structs/data-terraform-remote-state-azurerm-config.mdx +++ b/content/api-reference/typescript/structs/data-terraform-remote-state-azurerm-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateAzurermConfig description: CDKTN Core API Reference for DataTerraformRemoteStateAzurermConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/data-terraform-remote-state-config.mdx b/content/api-reference/typescript/structs/data-terraform-remote-state-config.mdx index 82dfb81..36bd7ee 100644 --- a/content/api-reference/typescript/structs/data-terraform-remote-state-config.mdx +++ b/content/api-reference/typescript/structs/data-terraform-remote-state-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConfig description: CDKTN Core API Reference for DataTerraformRemoteStateConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/data-terraform-remote-state-consul-config.mdx b/content/api-reference/typescript/structs/data-terraform-remote-state-consul-config.mdx index 6d9a376..19af4a2 100644 --- a/content/api-reference/typescript/structs/data-terraform-remote-state-consul-config.mdx +++ b/content/api-reference/typescript/structs/data-terraform-remote-state-consul-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateConsulConfig description: CDKTN Core API Reference for DataTerraformRemoteStateConsulConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/data-terraform-remote-state-cos-config.mdx b/content/api-reference/typescript/structs/data-terraform-remote-state-cos-config.mdx index 749fac2..51a5e7b 100644 --- a/content/api-reference/typescript/structs/data-terraform-remote-state-cos-config.mdx +++ b/content/api-reference/typescript/structs/data-terraform-remote-state-cos-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateCosConfig description: CDKTN Core API Reference for DataTerraformRemoteStateCosConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/data-terraform-remote-state-gcs-config.mdx b/content/api-reference/typescript/structs/data-terraform-remote-state-gcs-config.mdx index c9a4f70..f98f57a 100644 --- a/content/api-reference/typescript/structs/data-terraform-remote-state-gcs-config.mdx +++ b/content/api-reference/typescript/structs/data-terraform-remote-state-gcs-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateGcsConfig description: CDKTN Core API Reference for DataTerraformRemoteStateGcsConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/data-terraform-remote-state-http-config.mdx b/content/api-reference/typescript/structs/data-terraform-remote-state-http-config.mdx index 34b32cc..2c645df 100644 --- a/content/api-reference/typescript/structs/data-terraform-remote-state-http-config.mdx +++ b/content/api-reference/typescript/structs/data-terraform-remote-state-http-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateHttpConfig description: CDKTN Core API Reference for DataTerraformRemoteStateHttpConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/data-terraform-remote-state-local-config.mdx b/content/api-reference/typescript/structs/data-terraform-remote-state-local-config.mdx index 3af317a..78d0705 100644 --- a/content/api-reference/typescript/structs/data-terraform-remote-state-local-config.mdx +++ b/content/api-reference/typescript/structs/data-terraform-remote-state-local-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateLocalConfig description: CDKTN Core API Reference for DataTerraformRemoteStateLocalConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/data-terraform-remote-state-oss-config.mdx b/content/api-reference/typescript/structs/data-terraform-remote-state-oss-config.mdx index 4dedfad..2c087de 100644 --- a/content/api-reference/typescript/structs/data-terraform-remote-state-oss-config.mdx +++ b/content/api-reference/typescript/structs/data-terraform-remote-state-oss-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateOssConfig description: CDKTN Core API Reference for DataTerraformRemoteStateOssConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/data-terraform-remote-state-pg-config.mdx b/content/api-reference/typescript/structs/data-terraform-remote-state-pg-config.mdx index d4707c7..25b8f63 100644 --- a/content/api-reference/typescript/structs/data-terraform-remote-state-pg-config.mdx +++ b/content/api-reference/typescript/structs/data-terraform-remote-state-pg-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStatePgConfig description: CDKTN Core API Reference for DataTerraformRemoteStatePgConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/data-terraform-remote-state-remote-config.mdx b/content/api-reference/typescript/structs/data-terraform-remote-state-remote-config.mdx index 55ac762..218a67f 100644 --- a/content/api-reference/typescript/structs/data-terraform-remote-state-remote-config.mdx +++ b/content/api-reference/typescript/structs/data-terraform-remote-state-remote-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateRemoteConfig description: CDKTN Core API Reference for DataTerraformRemoteStateRemoteConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/data-terraform-remote-state-s3-config.mdx b/content/api-reference/typescript/structs/data-terraform-remote-state-s3-config.mdx index cfdfddc..f9c98c2 100644 --- a/content/api-reference/typescript/structs/data-terraform-remote-state-s3-config.mdx +++ b/content/api-reference/typescript/structs/data-terraform-remote-state-s3-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateS3Config description: CDKTN Core API Reference for DataTerraformRemoteStateS3Config in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer @@ -68,6 +68,7 @@ const dataTerraformRemoteStateS3Config: DataTerraformRemoteStateS3Config = { ... | stsRegion | string | (Optional) AWS region for STS. | | token | string | (Optional) Multi-Factor Authentication (MFA) token. | | useLegacyWorkflow | boolean | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. | +| useLockfile | boolean | (Optional) Whether to use a lockfile for locking the state file. | | usePathStyle | boolean | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). | | workspaceKeyPrefix | string | (Optional) Prefix applied to the state path inside the bucket. | @@ -276,7 +277,9 @@ This can also be sourced from the AWS\_DYNAMODB\_ENDPOINT environment variable. *** -### `dynamodbTable`Optional +### ~~`dynamodbTable`~~Optional + +- *Deprecated:* Use useLockfile instead, which uses S3 for locking ```typescript public readonly dynamodbTable: string; @@ -780,6 +783,25 @@ This behavior does not align with the authentication flow of the AWS CLI or SDK' *** +### `useLockfile`Optional + +```typescript +public readonly useLockfile: boolean; +``` + +- *Type:* boolean + +(Optional) Whether to use a lockfile for locking the state file. + +Defaults to false. +State locking is an opt-in feature of the S3 backend. +Locking can be enabled via S3 or DynamoDB (see dynamodbTable). However, DynamoDB-based locking +is deprecated and will be removed in a future minor version. To support migration from older +versions of Terraform that only support DynamoDB-based locking, the S3 (useLockfile) and DynamoDB +(dynamodbTable) arguments can be configured simultaneously. + +*** + ### `usePathStyle`Optional ```typescript diff --git a/content/api-reference/typescript/structs/data-terraform-remote-state-swift-config.mdx b/content/api-reference/typescript/structs/data-terraform-remote-state-swift-config.mdx index b3a24dc..73ba08a 100644 --- a/content/api-reference/typescript/structs/data-terraform-remote-state-swift-config.mdx +++ b/content/api-reference/typescript/structs/data-terraform-remote-state-swift-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: DataTerraformRemoteStateSwiftConfig description: CDKTN Core API Reference for DataTerraformRemoteStateSwiftConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/encoding-options.mdx b/content/api-reference/typescript/structs/encoding-options.mdx index b3c9f75..1d060de 100644 --- a/content/api-reference/typescript/structs/encoding-options.mdx +++ b/content/api-reference/typescript/structs/encoding-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: EncodingOptions description: CDKTN Core API Reference for EncodingOptions in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Properties to string encodings. diff --git a/content/api-reference/typescript/structs/file-provisioner.mdx b/content/api-reference/typescript/structs/file-provisioner.mdx index 4eb7c09..234a80b 100644 --- a/content/api-reference/typescript/structs/file-provisioner.mdx +++ b/content/api-reference/typescript/structs/file-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: FileProvisioner description: CDKTN Core API Reference for FileProvisioner in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The file provisioner copies files or directories from the machine running Terraform to the newly created resource. diff --git a/content/api-reference/typescript/structs/gcs-backend-config.mdx b/content/api-reference/typescript/structs/gcs-backend-config.mdx index da755c9..b2c9363 100644 --- a/content/api-reference/typescript/structs/gcs-backend-config.mdx +++ b/content/api-reference/typescript/structs/gcs-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: GcsBackendConfig description: CDKTN Core API Reference for GcsBackendConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as an object in a configurable prefix in a pre-existing bucket on Google Cloud Storage (GCS). diff --git a/content/api-reference/typescript/structs/http-backend-config.mdx b/content/api-reference/typescript/structs/http-backend-config.mdx index 9214678..becab2b 100644 --- a/content/api-reference/typescript/structs/http-backend-config.mdx +++ b/content/api-reference/typescript/structs/http-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: HttpBackendConfig description: CDKTN Core API Reference for HttpBackendConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state using a simple REST client. diff --git a/content/api-reference/typescript/structs/lazy-any-value-options.mdx b/content/api-reference/typescript/structs/lazy-any-value-options.mdx index 419632e..1e80453 100644 --- a/content/api-reference/typescript/structs/lazy-any-value-options.mdx +++ b/content/api-reference/typescript/structs/lazy-any-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyAnyValueOptions description: CDKTN Core API Reference for LazyAnyValueOptions in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating lazy untyped tokens. diff --git a/content/api-reference/typescript/structs/lazy-list-value-options.mdx b/content/api-reference/typescript/structs/lazy-list-value-options.mdx index 64b69fc..8007291 100644 --- a/content/api-reference/typescript/structs/lazy-list-value-options.mdx +++ b/content/api-reference/typescript/structs/lazy-list-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyListValueOptions description: CDKTN Core API Reference for LazyListValueOptions in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating a lazy list token. diff --git a/content/api-reference/typescript/structs/lazy-string-value-options.mdx b/content/api-reference/typescript/structs/lazy-string-value-options.mdx index 7bdf406..1cbb01a 100644 --- a/content/api-reference/typescript/structs/lazy-string-value-options.mdx +++ b/content/api-reference/typescript/structs/lazy-string-value-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: LazyStringValueOptions description: CDKTN Core API Reference for LazyStringValueOptions in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options for creating a lazy string token. diff --git a/content/api-reference/typescript/structs/local-backend-config.mdx b/content/api-reference/typescript/structs/local-backend-config.mdx index 027bfa6..6351c35 100644 --- a/content/api-reference/typescript/structs/local-backend-config.mdx +++ b/content/api-reference/typescript/structs/local-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalBackendConfig description: CDKTN Core API Reference for LocalBackendConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The local backend stores state on the local filesystem, locks that state using system APIs, and performs operations locally. diff --git a/content/api-reference/typescript/structs/local-exec-provisioner.mdx b/content/api-reference/typescript/structs/local-exec-provisioner.mdx index 1d82d94..9ad4f31 100644 --- a/content/api-reference/typescript/structs/local-exec-provisioner.mdx +++ b/content/api-reference/typescript/structs/local-exec-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: LocalExecProvisioner description: CDKTN Core API Reference for LocalExecProvisioner in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The local-exec provisioner invokes a local executable after a resource is created. diff --git a/content/api-reference/typescript/structs/oss-assume-role.mdx b/content/api-reference/typescript/structs/oss-assume-role.mdx index c8c0559..1bc601c 100644 --- a/content/api-reference/typescript/structs/oss-assume-role.mdx +++ b/content/api-reference/typescript/structs/oss-assume-role.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssAssumeRole description: CDKTN Core API Reference for OssAssumeRole in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/oss-backend-config.mdx b/content/api-reference/typescript/structs/oss-backend-config.mdx index 18a9c44..0b3f934 100644 --- a/content/api-reference/typescript/structs/oss-backend-config.mdx +++ b/content/api-reference/typescript/structs/oss-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: OssBackendConfig description: CDKTN Core API Reference for OssBackendConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/pg-backend-config.mdx b/content/api-reference/typescript/structs/pg-backend-config.mdx index 6dbe33c..e15b550 100644 --- a/content/api-reference/typescript/structs/pg-backend-config.mdx +++ b/content/api-reference/typescript/structs/pg-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: PgBackendConfig description: CDKTN Core API Reference for PgBackendConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/postcondition.mdx b/content/api-reference/typescript/structs/postcondition.mdx index b1748f3..f7e56b8 100644 --- a/content/api-reference/typescript/structs/postcondition.mdx +++ b/content/api-reference/typescript/structs/postcondition.mdx @@ -4,7 +4,7 @@ sidebarTitle: Postcondition description: CDKTN Core API Reference for Postcondition in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Terraform checks a postcondition after evaluating the object it is associated with. diff --git a/content/api-reference/typescript/structs/precondition.mdx b/content/api-reference/typescript/structs/precondition.mdx index 317ecd3..0ae8fcd 100644 --- a/content/api-reference/typescript/structs/precondition.mdx +++ b/content/api-reference/typescript/structs/precondition.mdx @@ -4,7 +4,7 @@ sidebarTitle: Precondition description: CDKTN Core API Reference for Precondition in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Terraform checks a precondition before evaluating the object it is associated with. diff --git a/content/api-reference/typescript/structs/remote-backend-config.mdx b/content/api-reference/typescript/structs/remote-backend-config.mdx index 0d5bdfa..0aea28e 100644 --- a/content/api-reference/typescript/structs/remote-backend-config.mdx +++ b/content/api-reference/typescript/structs/remote-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteBackendConfig description: CDKTN Core API Reference for RemoteBackendConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/remote-exec-provisioner.mdx b/content/api-reference/typescript/structs/remote-exec-provisioner.mdx index 01ebc68..fceeb83 100644 --- a/content/api-reference/typescript/structs/remote-exec-provisioner.mdx +++ b/content/api-reference/typescript/structs/remote-exec-provisioner.mdx @@ -4,7 +4,7 @@ sidebarTitle: RemoteExecProvisioner description: CDKTN Core API Reference for RemoteExecProvisioner in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} The remote-exec provisioner invokes a script on a remote resource after it is created. diff --git a/content/api-reference/typescript/structs/resolve-options.mdx b/content/api-reference/typescript/structs/resolve-options.mdx index edf76ad..1bce439 100644 --- a/content/api-reference/typescript/structs/resolve-options.mdx +++ b/content/api-reference/typescript/structs/resolve-options.mdx @@ -4,7 +4,7 @@ sidebarTitle: ResolveOptions description: CDKTN Core API Reference for ResolveOptions in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Options to the resolve() operation. diff --git a/content/api-reference/typescript/structs/s3-backend-assume-role-config.mdx b/content/api-reference/typescript/structs/s3-backend-assume-role-config.mdx index 5e025be..ffd50dc 100644 --- a/content/api-reference/typescript/structs/s3-backend-assume-role-config.mdx +++ b/content/api-reference/typescript/structs/s3-backend-assume-role-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendAssumeRoleConfig description: CDKTN Core API Reference for S3BackendAssumeRoleConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/s3-backend-assume-role-with-web-identity-config.mdx b/content/api-reference/typescript/structs/s3-backend-assume-role-with-web-identity-config.mdx index 473fa7d..8012dca 100644 --- a/content/api-reference/typescript/structs/s3-backend-assume-role-with-web-identity-config.mdx +++ b/content/api-reference/typescript/structs/s3-backend-assume-role-with-web-identity-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendAssumeRoleWithWebIdentityConfig description: CDKTN Core API Reference for S3BackendAssumeRoleWithWebIdentityConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/s3-backend-config.mdx b/content/api-reference/typescript/structs/s3-backend-config.mdx index 2a1f6f2..3feb1d0 100644 --- a/content/api-reference/typescript/structs/s3-backend-config.mdx +++ b/content/api-reference/typescript/structs/s3-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendConfig description: CDKTN Core API Reference for S3BackendConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Stores the state as a given key in a given bucket on Amazon S3. @@ -82,6 +82,7 @@ const s3BackendConfig: S3BackendConfig = { ... } | stsRegion | string | (Optional) AWS region for STS. | | token | string | (Optional) Multi-Factor Authentication (MFA) token. | | useLegacyWorkflow | boolean | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. | +| useLockfile | boolean | (Optional) Whether to use a lockfile for locking the state file. | | usePathStyle | boolean | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). | | workspaceKeyPrefix | string | (Optional) Prefix applied to the state path inside the bucket. | @@ -270,7 +271,9 @@ This can also be sourced from the AWS\_DYNAMODB\_ENDPOINT environment variable. *** -### `dynamodbTable`Optional +### ~~`dynamodbTable`~~Optional + +- *Deprecated:* Use useLockfile instead, which uses S3 for locking ```typescript public readonly dynamodbTable: string; @@ -774,6 +777,25 @@ This behavior does not align with the authentication flow of the AWS CLI or SDK' *** +### `useLockfile`Optional + +```typescript +public readonly useLockfile: boolean; +``` + +- *Type:* boolean + +(Optional) Whether to use a lockfile for locking the state file. + +Defaults to false. +State locking is an opt-in feature of the S3 backend. +Locking can be enabled via S3 or DynamoDB (see dynamodbTable). However, DynamoDB-based locking +is deprecated and will be removed in a future minor version. To support migration from older +versions of Terraform that only support DynamoDB-based locking, the S3 (useLockfile) and DynamoDB +(dynamodbTable) arguments can be configured simultaneously. + +*** + ### `usePathStyle`Optional ```typescript diff --git a/content/api-reference/typescript/structs/s3-backend-endpoint-config.mdx b/content/api-reference/typescript/structs/s3-backend-endpoint-config.mdx index 9b97371..c47e65d 100644 --- a/content/api-reference/typescript/structs/s3-backend-endpoint-config.mdx +++ b/content/api-reference/typescript/structs/s3-backend-endpoint-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: S3BackendEndpointConfig description: CDKTN Core API Reference for S3BackendEndpointConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/ssh-provisioner-connection.mdx b/content/api-reference/typescript/structs/ssh-provisioner-connection.mdx index d50f0b5..993fe51 100644 --- a/content/api-reference/typescript/structs/ssh-provisioner-connection.mdx +++ b/content/api-reference/typescript/structs/ssh-provisioner-connection.mdx @@ -4,7 +4,7 @@ sidebarTitle: SSHProvisionerConnection description: CDKTN Core API Reference for SSHProvisionerConnection in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect. diff --git a/content/api-reference/typescript/structs/stack-annotation.mdx b/content/api-reference/typescript/structs/stack-annotation.mdx index 19fba6a..f0f34b5 100644 --- a/content/api-reference/typescript/structs/stack-annotation.mdx +++ b/content/api-reference/typescript/structs/stack-annotation.mdx @@ -4,7 +4,7 @@ sidebarTitle: StackAnnotation description: CDKTN Core API Reference for StackAnnotation in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/stack-manifest.mdx b/content/api-reference/typescript/structs/stack-manifest.mdx index 1d6520e..84d18c5 100644 --- a/content/api-reference/typescript/structs/stack-manifest.mdx +++ b/content/api-reference/typescript/structs/stack-manifest.mdx @@ -4,7 +4,7 @@ sidebarTitle: StackManifest description: CDKTN Core API Reference for StackManifest in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/swift-backend-config.mdx b/content/api-reference/typescript/structs/swift-backend-config.mdx index dc4c51c..20c2a15 100644 --- a/content/api-reference/typescript/structs/swift-backend-config.mdx +++ b/content/api-reference/typescript/structs/swift-backend-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: SwiftBackendConfig description: CDKTN Core API Reference for SwiftBackendConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-asset-config.mdx b/content/api-reference/typescript/structs/terraform-asset-config.mdx index 8bfb999..2184c6c 100644 --- a/content/api-reference/typescript/structs/terraform-asset-config.mdx +++ b/content/api-reference/typescript/structs/terraform-asset-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformAssetConfig description: CDKTN Core API Reference for TerraformAssetConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-condition.mdx b/content/api-reference/typescript/structs/terraform-condition.mdx index b0fb0c0..3c56018 100644 --- a/content/api-reference/typescript/structs/terraform-condition.mdx +++ b/content/api-reference/typescript/structs/terraform-condition.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformCondition description: CDKTN Core API Reference for TerraformCondition in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-constructor.mdx b/content/api-reference/typescript/structs/terraform-constructor.mdx index 432a62a..1a84b67 100644 --- a/content/api-reference/typescript/structs/terraform-constructor.mdx +++ b/content/api-reference/typescript/structs/terraform-constructor.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformConstructor description: CDKTN Core API Reference for TerraformConstructor in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-element-metadata.mdx b/content/api-reference/typescript/structs/terraform-element-metadata.mdx index 44e3fd0..a0bf041 100644 --- a/content/api-reference/typescript/structs/terraform-element-metadata.mdx +++ b/content/api-reference/typescript/structs/terraform-element-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformElementMetadata description: CDKTN Core API Reference for TerraformElementMetadata in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-hcl-module-config.mdx b/content/api-reference/typescript/structs/terraform-hcl-module-config.mdx index 36ec36e..1ad48db 100644 --- a/content/api-reference/typescript/structs/terraform-hcl-module-config.mdx +++ b/content/api-reference/typescript/structs/terraform-hcl-module-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformHclModuleConfig description: CDKTN Core API Reference for TerraformHclModuleConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-meta-arguments.mdx b/content/api-reference/typescript/structs/terraform-meta-arguments.mdx index b6dcdf6..eec6a95 100644 --- a/content/api-reference/typescript/structs/terraform-meta-arguments.mdx +++ b/content/api-reference/typescript/structs/terraform-meta-arguments.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformMetaArguments description: CDKTN Core API Reference for TerraformMetaArguments in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-module-config.mdx b/content/api-reference/typescript/structs/terraform-module-config.mdx index b3fb158..c3fc70e 100644 --- a/content/api-reference/typescript/structs/terraform-module-config.mdx +++ b/content/api-reference/typescript/structs/terraform-module-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleConfig description: CDKTN Core API Reference for TerraformModuleConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-module-provider.mdx b/content/api-reference/typescript/structs/terraform-module-provider.mdx index 781ae23..3b91aa1 100644 --- a/content/api-reference/typescript/structs/terraform-module-provider.mdx +++ b/content/api-reference/typescript/structs/terraform-module-provider.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleProvider description: CDKTN Core API Reference for TerraformModuleProvider in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-module-user-config.mdx b/content/api-reference/typescript/structs/terraform-module-user-config.mdx index d3f587b..e3c755a 100644 --- a/content/api-reference/typescript/structs/terraform-module-user-config.mdx +++ b/content/api-reference/typescript/structs/terraform-module-user-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformModuleUserConfig description: CDKTN Core API Reference for TerraformModuleUserConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-output-config.mdx b/content/api-reference/typescript/structs/terraform-output-config.mdx index 927cb78..d6f6123 100644 --- a/content/api-reference/typescript/structs/terraform-output-config.mdx +++ b/content/api-reference/typescript/structs/terraform-output-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformOutputConfig description: CDKTN Core API Reference for TerraformOutputConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-provider-config.mdx b/content/api-reference/typescript/structs/terraform-provider-config.mdx index 81c813a..9828e82 100644 --- a/content/api-reference/typescript/structs/terraform-provider-config.mdx +++ b/content/api-reference/typescript/structs/terraform-provider-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProviderConfig description: CDKTN Core API Reference for TerraformProviderConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-provider-generator-metadata.mdx b/content/api-reference/typescript/structs/terraform-provider-generator-metadata.mdx index 29caa3a..3f57dc7 100644 --- a/content/api-reference/typescript/structs/terraform-provider-generator-metadata.mdx +++ b/content/api-reference/typescript/structs/terraform-provider-generator-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformProviderGeneratorMetadata description: CDKTN Core API Reference for TerraformProviderGeneratorMetadata in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-resource-config.mdx b/content/api-reference/typescript/structs/terraform-resource-config.mdx index f15242f..0215590 100644 --- a/content/api-reference/typescript/structs/terraform-resource-config.mdx +++ b/content/api-reference/typescript/structs/terraform-resource-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceConfig description: CDKTN Core API Reference for TerraformResourceConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-resource-import.mdx b/content/api-reference/typescript/structs/terraform-resource-import.mdx index 80174e6..46ef886 100644 --- a/content/api-reference/typescript/structs/terraform-resource-import.mdx +++ b/content/api-reference/typescript/structs/terraform-resource-import.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceImport description: CDKTN Core API Reference for TerraformResourceImport in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-resource-lifecycle.mdx b/content/api-reference/typescript/structs/terraform-resource-lifecycle.mdx index dc7b235..56876a6 100644 --- a/content/api-reference/typescript/structs/terraform-resource-lifecycle.mdx +++ b/content/api-reference/typescript/structs/terraform-resource-lifecycle.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceLifecycle description: CDKTN Core API Reference for TerraformResourceLifecycle in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-resource-move-by-id.mdx b/content/api-reference/typescript/structs/terraform-resource-move-by-id.mdx index 09340fb..6b25c12 100644 --- a/content/api-reference/typescript/structs/terraform-resource-move-by-id.mdx +++ b/content/api-reference/typescript/structs/terraform-resource-move-by-id.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceMoveById description: CDKTN Core API Reference for TerraformResourceMoveById in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-resource-move-by-target.mdx b/content/api-reference/typescript/structs/terraform-resource-move-by-target.mdx index ea69989..c5b238f 100644 --- a/content/api-reference/typescript/structs/terraform-resource-move-by-target.mdx +++ b/content/api-reference/typescript/structs/terraform-resource-move-by-target.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformResourceMoveByTarget description: CDKTN Core API Reference for TerraformResourceMoveByTarget in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-stack-metadata.mdx b/content/api-reference/typescript/structs/terraform-stack-metadata.mdx index d24f3c5..7913b57 100644 --- a/content/api-reference/typescript/structs/terraform-stack-metadata.mdx +++ b/content/api-reference/typescript/structs/terraform-stack-metadata.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformStackMetadata description: CDKTN Core API Reference for TerraformStackMetadata in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-variable-config.mdx b/content/api-reference/typescript/structs/terraform-variable-config.mdx index c6240f2..920930c 100644 --- a/content/api-reference/typescript/structs/terraform-variable-config.mdx +++ b/content/api-reference/typescript/structs/terraform-variable-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariableConfig description: CDKTN Core API Reference for TerraformVariableConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/terraform-variable-validation-config.mdx b/content/api-reference/typescript/structs/terraform-variable-validation-config.mdx index 6d6123a..b96b5a7 100644 --- a/content/api-reference/typescript/structs/terraform-variable-validation-config.mdx +++ b/content/api-reference/typescript/structs/terraform-variable-validation-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TerraformVariableValidationConfig description: CDKTN Core API Reference for TerraformVariableValidationConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Add one or more validation blocks within the variable block to specify custom conditions. diff --git a/content/api-reference/typescript/structs/testing-app-config.mdx b/content/api-reference/typescript/structs/testing-app-config.mdx index 907b62a..08ab372 100644 --- a/content/api-reference/typescript/structs/testing-app-config.mdx +++ b/content/api-reference/typescript/structs/testing-app-config.mdx @@ -4,7 +4,7 @@ sidebarTitle: TestingAppConfig description: CDKTN Core API Reference for TestingAppConfig in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} ## Initializer diff --git a/content/api-reference/typescript/structs/winrm-provisioner-connection.mdx b/content/api-reference/typescript/structs/winrm-provisioner-connection.mdx index 832d16b..8ce472b 100644 --- a/content/api-reference/typescript/structs/winrm-provisioner-connection.mdx +++ b/content/api-reference/typescript/structs/winrm-provisioner-connection.mdx @@ -4,7 +4,7 @@ sidebarTitle: WinrmProvisionerConnection description: CDKTN Core API Reference for WinrmProvisionerConnection in Typescript. --- -{/* This file is generated through yarn generate-docs */} +{/* This file is generated through pnpm generate-docs */} Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect.