Skip to content

Commit 9bf2300

Browse files
committed
added default and some descriptions
1 parent 93612a3 commit 9bf2300

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,20 @@ To try this integration out you can use the `sam` cli to deploy the cloudformati
2121
#### CloudFormation Parameters
2222

2323
- `NewRelicRegion` : Can either be `US` or `EU` depending on which endpoint to be used to push logs to New Relic
24+
- For this param `US` is default
2425
- `LicenseKey`: Used when forwarding logs to New Relic
2526
- `LogGroupConfig` : String representation of JSON array of objects of your CloudWatch LogGroup(s) and respective filter (if applicable) to set the Lambda function trigger.
2627
- Example : ```[{"LogGroupName":"group1"}, {"LogGroupName":"group2", "FilterPattern":"ERROR"}, {"LogGroupName":"group3", "FilterPattern":"INFO"}]```
2728
- `LoggingFirehoseStreamName` : Name of new Data Firehose Delivery Stream (must be unique per AWS account in the same AWS Region)
2829
- The default value will be `NewRelic-Logging-Delivery-Stream`
2930
- `LoggingS3BackupBucketName`: S3 Bucket Destination for failed events (must be globally unique across all AWS accounts in all AWS Regions within a partition)
3031
- The default value will be `firehose-logging-backup`
31-
- `EnableCloudWatchLoggingForFirehose`: Can either be `true` or `false` to enable CloudWatch logging for the Amazon Data Firehose stream.
32+
- `EnableCloudWatchLoggingForFirehose`: Can either be `true` or `false` to enable CloudWatch logging for the Amazon Data Firehose stream. Enabling logging can help in troubleshooting issues in pushing data through firehose stream. `false` by default
3233
- `NewRelicAccountId` : The New Relic Account ID to which the logs will be pushed
3334
- `CommonAttributes` : Common attributes to be added to all logs. This should be a JSON object.
3435
- Example : ```[{"AttributeName": "name1", "AttributeValue": "value1"}, {"AttributeName": "name2", "AttributeValue": "value2}]```
3536
- `StoreNRLicenseKeyInSecretManager` : Can either be `true` or `false` depending on which cloud formation stack decides whether to store your license key in the environment variables or to create a new secret in aws secrets manger.
37+
- For this param `true` is default
3638

3739
## Building and packaging
3840
To build and package, follow these steps:

0 commit comments

Comments
 (0)