Compile-time resource/data type name for TypeScript bindings

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave “+1” or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

Right now, generated TypeScript for the various available providers (@cdktf/provider-aws, @cdktf/provider-github, etc.) offer classes where the Terraform type is available as a static readonly string:

// .d.ts
export declare class LambdaFunction extends cdktf.TerraformResource {
  static readonly tfResourceType: string;
  // ...
}
// .ts
class LambdaFunction extends cdktf.TerraformResource {
  constructor(scope, id, config) {
    super(scope, id, {
      terraformResourceType: 'aws_lambda_function'
      // ...
    });
  }
}

While already convenient, this prevents doing some compile-time designs as the value is a simple string from TypeScript’s point of view.

As the value is known ahead of time and does not change, it would be nice having it directly available in the declaration:

// .d.ts
export declare class LambdaFunction extends cdktf.TerraformResource {
  static readonly tfResourceType: 'aws_lambda_function';
  // ...
}

References

n/a

[skorfmann]

Merged https://github.com/hashicorp/terraform-cdk/pull/1535

[github-actions[bot]]

I’m going to lock this issue because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you’ve found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.