diff --git a/modules/resource-metadata/README.md b/modules/resource-metadata/README.md index 6cc29791..08ff3edc 100644 --- a/modules/resource-metadata/README.md +++ b/modules/resource-metadata/README.md @@ -1,6 +1,6 @@ -# s3 +# resource-metadata -Manage the application which retrieves logs from `S3` bucket and sends them to your *Coralogix* account. +Manage the application which retrieves `meta data` from your aws account and sends them to your *Coralogix* account. ## Requirements @@ -28,22 +28,17 @@ Manage the application which retrieves logs from `S3` bucket and sends them to y |------|-------------|------|---------|:--------:| | [coralogix\_region](#input\_coralogix\_region) | The Coralogix location region, possible options are [`Europe`, `Europe2`, `India`, `Singapore`, `US`. `Custom`] | `string` | n/a | yes | | [custom_url](#input\_custom\_domain) | Custom url for coralogix for example: https:///api/v1/logs| `string` | n/a | no | -| [integration_type](#input\_data\_type) | which service will send the data to the s3, possible options are [`cloudtrail`, `vpc-flow-log`, `s3`, `s3-sns`, `cloudtrail-sns`] | `string` | n/a | yes | -| [sns_topic_name](#input\_sns\_topic\_name) | The SNS topic that will contain the SNS subscription, need only if you use the sns interations | `string` | | no | | [enable_ssm](#input\_enable_\_ssm) | store coralogix private_key as a secret so that it will not be save in the lambda. True/False | `string` | `False` | no | | [layer_arn](#input\_layer\_arn) | Coralogix SSM Layer ARN (if SsmEnabled set to false, can leave as empty). | `string` | n/a | no | | [private\_key](#input\_private\_key) | The Coralogix private key which is used to validate your authenticity | `string` | n/a | yes | -| [application\_name](#input\_application\_name) | The name of your application | `string` | n/a | yes | -| [subsystem\_name](#input\_subsystem\_name) | The subsystem name of your application | `string` | n/a | yes | -| [newline\_pattern](#input\_newline\_pattern) | The pattern for lines splitting | `string` | `(?:\r\n\|\r\|\n)` | no | +| [schedule](#input\_schedule) | The rate to collacet metadata | `string` | `rate(10 minutes)` | no | +| [latest_versions_per_function](#input\_latest\_versions\_per\_function) | How many latest published versions of each Lambda function should be collected | `number` | 5 | no | +| [resource_ttl_minutes](#input\_resource\_ttl\_minutes) | Once a resource is collected, how long should it remain valid | `number` | 60 | no | +| [collect_aliases](#input\_collect\_aliases) | Collect Aliases | `string` | `false` | no | | [blocking\_pattern](#input\_blocking\_pattern) | The pattern for lines blocking | `string` | `""` | no | | [buffer\_size](#input\_buffer\_size) | Coralogix logger buffer size | `number` | `134217728` | no | | [sampling\_rate](#input\_sampling\_rate) | Send messages with specific rate | `number` | `1` | no | -| [debug](#debug) | Coralogix logger debug mode | `bool` | `false` | no | -| [s3\_bucket\_name](#input\_s3\_bucket\_name) | The name of the S3 bucket to watch | `string` | n/a | yes | -| [s3\_key\_prefix](#input\_s3\_key\_prefix) | The S3 path prefix to watch | `string` | `null` | no | -| [s3\_key\_suffix](#input\_s3\_key\_suffix) | The S3 path suffix to watch | `string` | `null` | no | -| [memory\_size](#input\_memory\_size) | Lambda function memory limit | `number` | `1024` | no | +| [memory\_size](#input\_memory\_size) | Lambda function memory limit | `number` | `256` | no | | [timeout](#input\_timeout) | Lambda function timeout limit | `number` | `300` | no | | [architecture](#input\_architecture) | Lambda function architecture | `string` | `x86_64` | no | | [notification_email](#input\_notification\_email) | Failure notification email address | `string` | `null` | no |