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.TerraformDataSource(
scope: Construct,
id: str,
connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
count: typing.Union[int, float] | TerraformCount = None,
depends_on: typing.List[ITerraformDependable] = None,
for_each: ITerraformIterator = None,
lifecycle: TerraformResourceLifecycle = None,
provider: TerraformProvider = None,
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
terraform_resource_type: str,
terraform_generator_metadata: TerraformProviderGeneratorMetadata = None
)
scopeRequired
- Type: constructs.Construct
idRequired
connectionOptional
countOptional
depends_onOptional
for_eachOptional
lifecycleOptional
providerOptional
provisionersOptional
Methods
| Name | Description |
|---|
to_string | Returns a string representation of 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. |
to_hcl_terraform | Adds this resource to the terraform JSON output. |
to_metadata | No description. |
to_terraform | Adds this resource to the terraform JSON output. |
get_any_map_attribute | No description. |
get_boolean_attribute | No description. |
get_boolean_map_attribute | No description. |
get_list_attribute | No description. |
get_number_attribute | No description. |
get_number_list_attribute | No description. |
get_number_map_attribute | No description. |
get_string_attribute | No description. |
get_string_map_attribute | No description. |
interpolation_for_attribute | No description. |
to_string
Returns a string representation of this construct.
add_override
def add_override(
path: str,
value: typing.Any
) -> None
pathRequired
valueRequired
override_logical_id
def override_logical_id(
new_logical_id: str
) -> None
Overrides the auto-generated logical ID with a specific ID.
new_logical_idRequired
The new logical ID to use for this stack element.
reset_override_logical_id
def reset_override_logical_id() -> None
Resets a previously passed logical Id to use the auto-generated logical id again.
def to_hcl_terraform() -> typing.Any
Adds this resource to the terraform JSON output.
def to_metadata() -> typing.Any
def to_terraform() -> typing.Any
Adds this resource to the terraform JSON output.
get_any_map_attribute
def get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]
get_boolean_attribute
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable
get_boolean_map_attribute
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]
get_list_attribute
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]
get_number_attribute
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]
get_number_list_attribute
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
get_number_map_attribute
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
get_string_attribute
def get_string_attribute(
terraform_attribute: str
) -> str
get_string_map_attribute
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]
interpolation_for_attribute
def interpolation_for_attribute(
terraform_attribute: str
) -> IResolvable
Static Functions
| Name | Description |
|---|
is_construct | Checks if x is a construct. |
is_terraform_element | No description. |
is_terraform_data_source | No description. |
is_construct
import cdktn
cdktn.TerraformDataSource.is_construct(
x: typing.Any
)
Checks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
xRequired
Any object.
import cdktn
cdktn.TerraformDataSource.is_terraform_element(
x: typing.Any
)
xRequired
import cdktn
cdktn.TerraformDataSource.is_terraform_data_source(
x: typing.Any
)
xRequired
Properties
| Name | Type | Description |
|---|
node | constructs.Node | The tree node. |
cdktf_stack | TerraformStack | No description. |
fqn | str | No description. |
friendly_unique_id | str | No description. |
terraform_meta_arguments | typing.Mapping[typing.Any] | No description. |
terraform_resource_type | str | No description. |
terraform_generator_metadata | TerraformProviderGeneratorMetadata | No description. |
count | typing.Union[int, float] | TerraformCount | No description. |
depends_on | typing.List[str] | No description. |
for_each | ITerraformIterator | No description. |
lifecycle | TerraformResourceLifecycle | No description. |
provider | TerraformProvider | No description. |
nodeRequired
The tree node.
cdktf_stackRequired
cdktf_stack: TerraformStack
fqnRequired
friendly_unique_idRequired
terraform_meta_arguments: typing.Mapping[typing.Any]
- Type: typing.Mapping[typing.Any]
terraform_resource_type: str
terraform_generator_metadata: TerraformProviderGeneratorMetadata
countOptional
count: typing.Union[int, float] | TerraformCount
depends_onOptional
depends_on: typing.List[str]
for_eachOptional
for_each: ITerraformIterator
lifecycleOptional
lifecycle: TerraformResourceLifecycle
providerOptional
provider: TerraformProvider