Filtering documentation sorely needed

[mmigliari]

For such an amazing project, terraformer is sorely lacking in propper documentation about filter usage.

• There are no clear instructions on how you can find names for fields you want to search for.
• There are not enough examples.
• Ideally the main README should teach how to figure it out for yourself.

For instance, in the case of Cloudfront distributions in AWS:
In the case of the fictitious XXXXXXXX distribution Id I want to search for, and only fetch info for that distribution:

• terraformer import aws --resources=cloudfront --filter="id=XXXXXXXX" won´t work.
• terraformer import aws --resources=cloudfront --filter="id=XXXXXXXX" won´t work.
• terraformer import aws --resources=cloudfront --filter=cloudfront=origin_id:XXXXXXXXX won´t work

What works:

• terraformer import aws --resources=cloudfront --filter="Name=id;Value=XXXXXXXXXX"

Its a little confusing and varies a lot from resource to resource, so explaining the logic in the documentation and add a bunch of examples would be ideal.

[mmigliari]

Whenever I come across comments related to terraformer usage, the one area people always seem to stumble uppon is filtering. I believe this needs either an overhawl, or very clear and detailed documentation, with several examples, for each resource type.

To me, filtering seems totally broken.

In the terraformer AWS documentation section, where all the supported resources are listed, there should be at the very least an example of how to filter each resource by its primary id. This varies a lot according to each resource type.

Countless people are wasting their time trying to figure this out, when the official documentation should have more verbose and precise documentation about this.

This would be much appreciated by everyone using this project, especially less experienced devs/ops ppl.

[mmigliari]

Problem:

When you do:

terraformer import aws --resources=alb --region=<my-region>

It imports all underlying resources, i.e.

• aws_lb
• aws_lb_listener
• aws_lb_listener_rule
• aws_lb_listener_certificate
• aws_lb_target_group
• aws_lb_target_group_attachment

However, if you filter the alb you want by filtering it via id (arn), it does not import all its underlying resources, but simply the lonely aws_lb.

terraformer import aws --resources=alb --filter="Name=id;Value='arn:aws.......' --regions=<my-region>

This is inconsistent behavior and makes importing a single ALB and its underlying resources a complete chore.