- Implements: ITerraformResource, ITerraformDependable, IInterpolatingParent
Initializers
| Name | Type | Description |
|---|---|---|
scope | constructs.Construct | No description. |
id | str | No description. |
connection | SSHProvisionerConnection | WinrmProvisionerConnection | No description. |
count | typing.Union[int, float] | TerraformCount | No description. |
depends_on | typing.List[ITerraformDependable] | No description. |
for_each | ITerraformIterator | No description. |
lifecycle | TerraformResourceLifecycle | No description. |
provider | TerraformProvider | No description. |
provisioners | typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] | No description. |
terraform_resource_type | str | No description. |
terraform_generator_metadata | TerraformProviderGeneratorMetadata | No description. |
scopeRequired
- Type: constructs.Construct
idRequired
- Type: str
connectionOptional
countOptional
- Type: typing.Union[int, float] | TerraformCount
depends_onOptional
- Type: typing.List[ITerraformDependable]
for_eachOptional
- Type: ITerraformIterator
lifecycleOptional
providerOptional
- Type: TerraformProvider
provisionersOptional
- Type: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]
terraform_resource_typeRequired
- Type: str
terraform_generator_metadataOptional
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
add_override
pathRequired
- Type: str
valueRequired
- Type: typing.Any
override_logical_id
new_logical_idRequired
- Type: str
reset_override_logical_id
to_hcl_terraform
to_metadata
to_terraform
get_any_map_attribute
terraform_attributeRequired
- Type: str
get_boolean_attribute
terraform_attributeRequired
- Type: str
get_boolean_map_attribute
terraform_attributeRequired
- Type: str
get_list_attribute
terraform_attributeRequired
- Type: str
get_number_attribute
terraform_attributeRequired
- Type: str
get_number_list_attribute
terraform_attributeRequired
- Type: str
get_number_map_attribute
terraform_attributeRequired
- Type: str
get_string_attribute
terraform_attributeRequired
- Type: str
get_string_map_attribute
terraform_attributeRequired
- Type: str
interpolation_for_attribute
terraform_attributeRequired
- Type: str
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
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
- Type: typing.Any
is_terraform_element
xRequired
- Type: typing.Any
is_terraform_data_source
xRequired
- Type: typing.Any
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
- Type: constructs.Node
cdktf_stackRequired
- Type: TerraformStack
fqnRequired
- Type: str
friendly_unique_idRequired
- Type: str
terraform_meta_argumentsRequired
- Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired
- Type: str
terraform_generator_metadataOptional
countOptional
- Type: typing.Union[int, float] | TerraformCount
depends_onOptional
- Type: typing.List[str]
for_eachOptional
- Type: ITerraformIterator
lifecycleOptional
providerOptional
- Type: TerraformProvider