Keys of user supplied input objects should keep character casing

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

cdktf & Language Versions

Typescript 0.0.12

Affected Resource(s)

ApiGatewayMethodConfig.requestParameters

Debug Output

https://gist.github.com/exocom/611c59e13542b90fa378eccd5647b121

Expected Behavior

The prop name should not have been modified resulting in a plan with "method.request.header.x-api-key" = true

      + request_parameters   = {
          + "method.request.header.x-api-key" = true
        }

Actual Behavior

The prop name is lowercase with “.” & “-” replaced with “_”. IE it has been normalized. "method_request_header_x_api_key"

      + request_parameters   = {
          + "method_request_header_x_api_key" = true
        }

Steps to Reproduce

new ApiGatewayMethod(this, `${id}_agm`, {
  ...
  requestParameters: {'method.request.header.x-api-key': true}
});

Important Factoids

Having dots/periods (.) in prop name works in plain .tf files. See example on official docs

 request_parameters = {
    "method.request.path.proxy" = true
  }

References

[skorfmann]

@exocom FYI: You can workaround this with escape hatches for now.

This would look like this:

const apiMethod = new ApiGatewayMethod(this, `agm`, {
      authorization: "NONE",
      httpMethod: "GET",
      resourceId: 'Foo',
      restApiId: 'bar',
    });

    apiMethod.addOverride('request_parameters', {'method.request.header.x-api-key': true})

and synthesizes to this:

    "aws_api_gateway_method": {
      "helloterra_agm_50C0F401": {
        "authorization": "NONE",
        "http_method": "GET",
        "request_parameters": {
          "method.request.header.x-api-key": true
        },
        "resource_id": "Foo",
        "rest_api_id": "bar"        
      }
    },

[exocom]

@skorfmann Nice workaround. I’m back on track thank you!