Skip to main content

Initializers

import cdktn

cdktn.TerraformProvider(
  scope: Construct,
  id: str,
  terraform_resource_type: str,
  terraform_generator_metadata: TerraformProviderGeneratorMetadata = None,
  terraform_provider_source: str = None
)
NameTypeDescription
scopeconstructs.ConstructNo description.
idstrNo description.
terraform_resource_typestrNo description.
terraform_generator_metadataTerraformProviderGeneratorMetadataNo description.
terraform_provider_sourcestrNo description.

scopeRequired

  • Type: constructs.Construct

idRequired

  • Type: str

terraform_resource_typeRequired

  • Type: str

terraform_generator_metadataOptional


terraform_provider_sourceOptional

  • Type: str

Methods

NameDescription
to_stringReturns a string representation of this construct.
add_overrideNo description.
override_logical_idOverrides the auto-generated logical ID with a specific ID.
reset_override_logical_idResets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraformNo description.
to_metadataNo description.
to_terraformAdds this resource to the terraform JSON output.

to_string

def to_string() -> str
Returns a string representation of this construct.

add_override

def add_override(
  path: str,
  value: typing.Any
) -> None

pathRequired

  • Type: str

valueRequired

  • Type: typing.Any

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

  • Type: str
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.

to_hcl_terraform

def to_hcl_terraform() -> typing.Any

to_metadata

def to_metadata() -> typing.Any

to_terraform

def to_terraform() -> typing.Any
Adds this resource to the terraform JSON output.

Static Functions

NameDescription
is_constructChecks if x is a construct.
is_terraform_elementNo description.
is_terraform_providerNo description.

is_construct

import cdktn

cdktn.TerraformProvider.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

  • Type: typing.Any
Any object.

is_terraform_element

import cdktn

cdktn.TerraformProvider.is_terraform_element(
  x: typing.Any
)

xRequired

  • Type: typing.Any

is_terraform_provider

import cdktn

cdktn.TerraformProvider.is_terraform_provider(
  x: typing.Any
)

xRequired

  • Type: typing.Any

Properties

NameTypeDescription
nodeconstructs.NodeThe tree node.
cdktf_stackTerraformStackNo description.
fqnstrNo description.
friendly_unique_idstrNo description.
meta_attributestyping.Mapping[typing.Any]No description.
terraform_resource_typestrNo description.
terraform_generator_metadataTerraformProviderGeneratorMetadataNo description.
terraform_provider_sourcestrNo description.
aliasstrNo description.

nodeRequired

node: Node
  • Type: constructs.Node
The tree node.

cdktf_stackRequired

cdktf_stack: TerraformStack

fqnRequired

fqn: str
  • Type: str

friendly_unique_idRequired

friendly_unique_id: str
  • Type: str

meta_attributesRequired

meta_attributes: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]

terraform_resource_typeRequired

terraform_resource_type: str
  • Type: str

terraform_generator_metadataOptional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

terraform_provider_sourceOptional

terraform_provider_source: str
  • Type: str

aliasOptional

alias: str
  • Type: str