search

amplify-education / serverless-vpc-discovery

Serverless plugin for discovering VPC / Subnet / Security Group configuration by name.
MIT License
38 stars 15 forks source link

Improve readme around tags #71

Closed wduminy closed 9 months ago

wduminy commented 2 years ago

In the readme I see

The vpc discovery plugin takes the given vpc name, subnet tag key/value, and security group tag key/value or names in the serverless file to setup the vpc configuration for the lambda.

But is it not clear what the values of the tags should be. For example, what are the valid values for securityGroups.tagKey

 securityGroups:
      - tagKey: <tag_name>

An easy fix could be to update the readme file and use real values instead of place holders (<tag_name>) so that one can see how the config translates to the generated config.

rddimon commented 9 months ago

Hi @wduminy

We don't know your real values that is why used some examples.

Here you can find a better example of the config.

Please try our latest version and let us know in case of any issues.