Documentation Index
Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt
Use this file to discover all available pages before exploring further.
Initializers
import cdktn
cdktn.TerraformStack(
scope: Construct,
id: str
)
| Name | Type | Description |
|---|
scope | constructs.Construct | No description. |
id | str | No description. |
scopeRequired
- Type: constructs.Construct
idRequired
Methods
| Name | Description |
|---|
to_string | Returns a string representation of this construct. |
add_dependency | No description. |
add_override | No description. |
all_providers | No description. |
depends_on | No description. |
ensure_backend_exists | No description. |
get_logical_id | No description. |
has_resource_move | No description. |
prepare_stack | No description. |
register_incoming_cross_stack_reference | No description. |
register_outgoing_cross_stack_reference | No description. |
run_all_validations | Run all validations on the stack. |
to_hcl_terraform | No description. |
to_terraform | No description. |
to_string
Returns a string representation of this construct.
add_dependency
def add_dependency(
dependency: TerraformStack
) -> None
dependencyRequired
add_override
def add_override(
path: str,
value: typing.Any
) -> None
pathRequired
valueRequired
all_providers
def all_providers() -> typing.List[TerraformProvider]
depends_on
def depends_on(
stack: TerraformStack
) -> bool
stackRequired
ensure_backend_exists
def ensure_backend_exists() -> TerraformBackend
get_logical_id
def get_logical_id(
tf_element: Node | TerraformElement
) -> str
tf_elementRequired
has_resource_move
def has_resource_move() -> bool
prepare_stack
def prepare_stack() -> None
register_incoming_cross_stack_reference
def register_incoming_cross_stack_reference(
from_stack: TerraformStack
) -> TerraformRemoteState
from_stackRequired
register_outgoing_cross_stack_reference
def register_outgoing_cross_stack_reference(
identifier: str
) -> TerraformOutput
identifierRequired
run_all_validations
def run_all_validations() -> None
def to_hcl_terraform() -> typing.Mapping[typing.Any]
def to_terraform() -> typing.Any
Static Functions
| Name | Description |
|---|
is_construct | Checks if x is a construct. |
is_stack | No description. |
of | No description. |
is_construct
import cdktn
cdktn.TerraformStack.is_construct(
x: typing.Any
)
x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
xRequired
Any object.
is_stack
import cdktn
cdktn.TerraformStack.is_stack(
x: typing.Any
)
xRequired
import cdktn
cdktn.TerraformStack.of(
construct: IConstruct
)
constructRequired
- Type: constructs.IConstruct
Properties
| Name | Type | Description |
|---|
node | constructs.Node | The tree node. |
dependencies | typing.List[TerraformStack] | No description. |
move_targets | TerraformResourceTargets | No description. |
synthesizer | IStackSynthesizer | No description. |
nodeRequired
The tree node.
dependenciesRequired
dependencies: typing.List[TerraformStack]
move_targetsRequired
move_targets: TerraformResourceTargets
synthesizerRequired
synthesizer: IStackSynthesizer
