Skip to content

Commit b25633f

Browse files
cds-719 fix rc workflow
1 parent f421212 commit b25633f

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

aws-integrations/aws-shipper-lambda/README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Coralogix can be configured to receive data directly from your [MSK](https://doc
4040

4141
### Amazon ECR Image Security Scan
4242

43-
Coralogix can be configured to recieve ECR [Image Scanning](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html)
43+
Coralogix can be configured to receive ECR [Image Scanning](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html).
4444

4545
## Deployment Options
4646

@@ -89,7 +89,7 @@ Use an existing Coralogix [Send-Your-Data API key](https://coralogix.com/docs/se
8989
| ApiKey | The Send-Your-Data [API Key](https://coralogix.com/docs/send-your-data-api-key/) validates your authenticity. This value can be a direct Coralogix API Key or an AWS Secret Manager ARN containing the API Key. | | :heavy_check_mark: |
9090
| StoreAPIKeyInSecretsManager | Enable this to store your API Key securely. Otherwise, it will remain exposed in plain text as an environment variable in the Lambda function console. | True | :heavy_check_mark: |
9191

92-
> **Note:** EcrScan doesn't need any extra configuration.
92+
> **Note:** `EcrScan` doesn't need any extra configuration.
9393
9494
### S3/CloudTrail/VpcFlow/S3Csv Configuration
9595

@@ -145,26 +145,24 @@ We can receive direct [Kinesis](https://aws.amazon.com/kinesis/) stream data fro
145145
|------------------|-----------------------------------------------------------------------------------------------|---------------|--------------------|
146146
| KinesisStreamARN | Provide the ARN of the Kinesis Stream to which you want to subscribe for retrieving messages. | | :heavy_check_mark: |
147147

148-
### MSK & Kafka Configuration
149-
150-
*Kafka*:
148+
### Kafka Configuration
151149

152150
| Parameter | Description | Default Value | Required |
153151
|---------------------|-------------------------------------------------------------------------------|---------------|--------------------|
154-
| KafkaBrokers | Comma Delimited List of Kafka broker to connect to | | :heavy_check_mark: |
155-
| KafkaTopic | The Kafka topic to subscribe to | | :heavy_check_mark: |
156-
| KafkaBatchSize | The Kafka batch size to use when reading from Kafka | 100 | |
157-
| KafkaSecurityGroups | Comma Delimited List of Kafka security groups to use when connecting to Kafka | | :heavy_check_mark: |
158-
| KafkaSubnets | Comma Delimited List of Kafka subnets to use when connecting to Kafka | | :heavy_check_mark: |
152+
| KafkaBrokers | Comma-delimited list of Kafka brokers to establish a connection with. | | :heavy_check_mark: |
153+
| KafkaTopic | Subscribe to this Kafka topic for data consumption. | | :heavy_check_mark: |
154+
| KafkaBatchSize | Specify the size of data batches to be read from Kafka during each retrieval. | 100 | |
155+
| KafkaSecurityGroups | Comma-delimited list of Kafka security groups for secure connection setup. | | :heavy_check_mark: |
156+
| KafkaSubnets | Comma-delimited list of Kafka subnets to use when connecting to Kafka. | | :heavy_check_mark: |
159157

160-
*MSK*:
158+
### MSK Configuration
161159

162-
When using the AWS MSK Integration, your Lambda must be in a VPC with access to the MSK cluster. You can do this by setting the relevant parameters for [vpc configuration](#vpc-configuration-optional).
160+
Your Lambda function must be in a VPC that has access to the MSK cluster. You can configure your VPC via the provided [VPC configuration parameters](#vpc-configuration-optional).
163161

164162
| Parameter | Description | Default Value | Required |
165163
|------------|--------------------------------------------------|---------------|--------------------|
166-
| MSKBrokers | Comma Delimited List of MSK broker to connect to | | :heavy_check_mark: |
167-
| KafkaTopic | The Kafka topic to subscribe to | | :heavy_check_mark: |
164+
| MSKBrokers | Comma-delimited list of MSK brokers to connect to. | | :heavy_check_mark: |
165+
| KafkaTopic | Subscribe to this Kafka topic for data consumption. | | :heavy_check_mark: |
168166

169167
### Generic Configuration (Optional)
170168

@@ -238,4 +236,4 @@ Set the MAX_ELAPSED_TIME variable for default change (default = 250). Set BATCHE
238236

239237
Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.
240238

241-
Contact us **via our in-app chat** or by emailing [support@coralogix.com](mailto:support@coralogix.com).
239+
Contact us **via our in-app chat** or by emailing [support@coralogix.com](mailto:support@coralogix.com).

0 commit comments

Comments
 (0)