Skip to content

Commit fcc7601

Browse files
alaudazzialaudazzi
committed
Update more aws packages
1 parent 275d049 commit fcc7601

File tree

14 files changed

+108
-120
lines changed

14 files changed

+108
-120
lines changed

‎packages/aws/_dev/build/docs/usage.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,31 @@ For example, you could use this integration to track your API call count per ser
88

99
**IMPORTANT: Extra AWS charges on API requests will be generated by this integration. Check [API Requests](https://www.elastic.co/docs/current/integrations/aws#api-requests) for more details.**
1010

11-
## Data streams
11+
## What data does this integration collect?
1212

1313
The AWS Usage integration collects one type of data: metrics.
1414

1515
**Metrics** give you insight into the state of your AWS Usage.
1616
Metrics collected by this integration include the number of specified API operations performed in your account, the number of the specified resources running in your account, and more. See more details in the [Metrics](#metrics-reference).
1717

18-
## Requirements
18+
## What do I need to use this integration?
1919

20-
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
21-
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
20+
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
2221

2322
Before using any AWS integration you will need:
2423

2524
* **AWS Credentials** to connect with your AWS account.
2625
* **AWS Permissions** to make sure the user you're using to connect has permission to share the relevant data.
2726

28-
For more details about these requirements, please take a look at the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
27+
For more details about these requirements, refer to the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
2928

3029
## Setup
3130

3231
Use this integration if you only need to collect usage data from AWS.
3332

3433
If you want to collect data from two or more AWS services, consider using the **AWS** integration. When you configure the AWS integration, you can collect data from as many AWS services as you'd like.
3534

36-
For step-by-step instructions on how to set up an integration, see the
35+
For step-by-step instructions on how to set up an integration, refer to the
3736
{{ url "getting-started-observability" "Getting started" }} guide.
3837

3938
## Metrics reference
@@ -45,6 +44,6 @@ An example event for `usage`looks like this:
4544

4645
**ECS Field Reference**
4746

48-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
47+
Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
4948

5049
{{fields "usage"}}

‎packages/aws/_dev/build/docs/vpcflow.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,23 @@ Then you can alert the relevant project manager about those events by email.
1414

1515
**IMPORTANT: Extra AWS charges on API requests will be generated by this integration. Check [API Requests](https://www.elastic.co/docs/current/integrations/aws#api-requests) for more details.**
1616

17-
## Data streams
17+
## What data does this integration collect?
1818

1919
The AWS VPC Flow integration collects one type of data: logs.
2020

2121
**Logs** help you keep a record of events happening in your VPCs.
2222
Logs collected by the vpcflow integration include the packet-level (original) source and destination IP addresses for the traffic, accepted traffic, rejected traffic, and more. See more details in the [Logs reference](#logs-reference).
2323

24-
## Requirements
24+
## What do I need to use this integration?
2525

26-
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
27-
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
26+
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
2827

2928
Before using any AWS integration you will need:
3029

3130
* **AWS Credentials** to connect with your AWS account.
3231
* **AWS Permissions** to make sure the user you're using to connect has permission to share the relevant data.
3332

34-
For more details about these requirements, please take a look at the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
33+
For more details about these requirements, refer to the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
3534

3635
## Setup
3736

@@ -43,7 +42,7 @@ When you configure the AWS integration, you can collect data from as many AWS se
4342
For step-by-step instructions on how to set up an integration, see the
4443
{{ url "getting-started-observability" "Getting started" }} guide.
4544

46-
For more information on implementation, see the Amazon documentation on:
45+
For more information on implementation, check the Amazon documentation on:
4746

4847
* [Default Flow Log Format](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html)
4948
* [Custom Format with Traffic Through a NAT Gateway](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs-records-examples.html)
@@ -82,11 +81,11 @@ The `number_of_workers` setting defines the number of workers assigned to readin
8281

8382
## Logs reference
8483

85-
> Note: The Parquet format is not supported.
84+
The Parquet format is not supported.
8685

8786
**ECS Field Reference**
8887

89-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
88+
Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
9089

9190
{{fields "vpcflow"}}
9291

‎packages/aws/_dev/build/docs/vpn.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,23 @@ You could use this data to view the state of each secure VPN tunnel that you hav
88

99
**IMPORTANT: Extra AWS charges on API requests will be generated by this integration. Check [API Requests](https://www.elastic.co/docs/current/integrations/aws#api-requests) for more details.**
1010

11-
## Data streams
11+
## What data does this integration collect?
1212

1313
The AWS VPN integration collects one type of data: metrics.
1414

1515
**Metrics** give you insight into the state of your AWS-hosted VPNs.
1616
Metrics collected by the Amazon VPN integration include the unique host ID, the host IP addresses, the name of the domain of which the host is a member, and more. See more details in the [Metrics reference](#metrics-reference).
1717

18-
## Requirements
18+
## What do I need to use this integration?
1919

20-
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
21-
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
20+
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
2221

2322
Before using any AWS integration you will need:
2423

2524
* **AWS Credentials** to connect with your AWS account.
2625
* **AWS Permissions** to make sure the user you're using to connect has permission to share the relevant data.
2726

28-
For more details about these requirements, please take a look at the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
27+
For more details about these requirements, refer to the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
2928

3029
## Setup
3130

@@ -34,7 +33,7 @@ Use this integration if you only need to collect VPN data from AWS.
3433
If you want to collect data from two or more AWS services, consider using the **AWS** integration.
3534
When you configure the AWS integration, you can collect data from as many AWS services as you'd like.
3635

37-
For step-by-step instructions on how to set up an integration, see the
36+
For step-by-step instructions on how to set up an integration, refer to the
3837
{{ url "getting-started-observability" "Getting started" }} guide.
3938

4039
## Metrics reference
@@ -43,6 +42,6 @@ For step-by-step instructions on how to set up an integration, see the
4342

4443
**ECS Field Reference**
4544

46-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
45+
Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
4746

4847
{{fields "vpn"}}

‎packages/aws/_dev/build/docs/waf.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,25 @@ For example, you could use the data from this integration to spot unusual SQL in
1010

1111
**IMPORTANT: Extra AWS charges on API requests will be generated by this integration. Check [API Requests](https://www.elastic.co/docs/current/integrations/aws#api-requests) for more details.**
1212

13-
## Data streams
13+
## What data does this integration collect?
1414

1515
The AWS WAF integration collects one type of data: logs.
1616

1717
**Logs** help you keep a record of events happening in AWS WAF.
1818
Logs collected by the AWS WAF integration include information on the rule that terminated a request, the source of the request, and more. See more details in the [Logs reference](#logs-reference).
1919

20-
> Note: The `waf` data stream is specifically for WAF logs.
20+
**NOTE**: The `waf` data stream is specifically for WAF logs.
2121

22-
## Requirements
22+
## What do I need to use this integration?
2323

24-
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
25-
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
24+
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
2625

2726
Before using any AWS integration you will need:
2827

2928
* **AWS Credentials** to connect with your AWS account.
3029
* **AWS Permissions** to make sure the user you're using to connect has permission to share the relevant data.
3130

32-
For more details about these requirements, please take a look at the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
31+
For more details about these requirements, refer to the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
3332

3433
## Setup
3534

@@ -65,7 +64,7 @@ The `waf` dataset is specifically for WAF logs. Export logs from Kinesis Data Fi
6564

6665
**ECS Field Reference**
6766

68-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
67+
Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
6968

7069
{{fields "waf"}}
7170

‎packages/aws/docs/usage.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,31 @@ For example, you could use this integration to track your API call count per ser
88

99
**IMPORTANT: Extra AWS charges on API requests will be generated by this integration. Check [API Requests](https://www.elastic.co/docs/current/integrations/aws#api-requests) for more details.**
1010

11-
## Data streams
11+
## What data does this integration collect?
1212

1313
The AWS Usage integration collects one type of data: metrics.
1414

1515
**Metrics** give you insight into the state of your AWS Usage.
1616
Metrics collected by this integration include the number of specified API operations performed in your account, the number of the specified resources running in your account, and more. See more details in the [Metrics](#metrics-reference).
1717

18-
## Requirements
18+
## What do I need to use this integration?
1919

20-
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
21-
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
20+
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
2221

2322
Before using any AWS integration you will need:
2423

2524
* **AWS Credentials** to connect with your AWS account.
2625
* **AWS Permissions** to make sure the user you're using to connect has permission to share the relevant data.
2726

28-
For more details about these requirements, please take a look at the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
27+
For more details about these requirements, refer to the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
2928

3029
## Setup
3130

3231
Use this integration if you only need to collect usage data from AWS.
3332

3433
If you want to collect data from two or more AWS services, consider using the **AWS** integration. When you configure the AWS integration, you can collect data from as many AWS services as you'd like.
3534

36-
For step-by-step instructions on how to set up an integration, see the
35+
For step-by-step instructions on how to set up an integration, refer to the
3736
[Getting started](https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/getting-started-observability.html) guide.
3837

3938
## Metrics reference
@@ -111,7 +110,7 @@ An example event for `usage` looks as following:
111110

112111
**ECS Field Reference**
113112

114-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
113+
Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
115114

116115
**Exported fields**
117116

‎packages/aws/docs/vpcflow.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,23 @@ Then you can alert the relevant project manager about those events by email.
1414

1515
**IMPORTANT: Extra AWS charges on API requests will be generated by this integration. Check [API Requests](https://www.elastic.co/docs/current/integrations/aws#api-requests) for more details.**
1616

17-
## Data streams
17+
## What data does this integration collect?
1818

1919
The AWS VPC Flow integration collects one type of data: logs.
2020

2121
**Logs** help you keep a record of events happening in your VPCs.
2222
Logs collected by the vpcflow integration include the packet-level (original) source and destination IP addresses for the traffic, accepted traffic, rejected traffic, and more. See more details in the [Logs reference](#logs-reference).
2323

24-
## Requirements
24+
## What do I need to use this integration?
2525

26-
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
27-
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
26+
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
2827

2928
Before using any AWS integration you will need:
3029

3130
* **AWS Credentials** to connect with your AWS account.
3231
* **AWS Permissions** to make sure the user you're using to connect has permission to share the relevant data.
3332

34-
For more details about these requirements, please take a look at the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
33+
For more details about these requirements, refer to the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
3534

3635
## Setup
3736

@@ -43,7 +42,7 @@ When you configure the AWS integration, you can collect data from as many AWS se
4342
For step-by-step instructions on how to set up an integration, see the
4443
[Getting started](https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/getting-started-observability.html) guide.
4544

46-
For more information on implementation, see the Amazon documentation on:
45+
For more information on implementation, check the Amazon documentation on:
4746

4847
* [Default Flow Log Format](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html)
4948
* [Custom Format with Traffic Through a NAT Gateway](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs-records-examples.html)
@@ -82,11 +81,11 @@ The `number_of_workers` setting defines the number of workers assigned to readin
8281

8382
## Logs reference
8483

85-
> Note: The Parquet format is not supported.
84+
The Parquet format is not supported.
8685

8786
**ECS Field Reference**
8887

89-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
88+
Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
9089

9190
**Exported fields**
9291

‎packages/aws/docs/vpn.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,23 @@ You could use this data to view the state of each secure VPN tunnel that you hav
88

99
**IMPORTANT: Extra AWS charges on API requests will be generated by this integration. Check [API Requests](https://www.elastic.co/docs/current/integrations/aws#api-requests) for more details.**
1010

11-
## Data streams
11+
## What data does this integration collect?
1212

1313
The AWS VPN integration collects one type of data: metrics.
1414

1515
**Metrics** give you insight into the state of your AWS-hosted VPNs.
1616
Metrics collected by the Amazon VPN integration include the unique host ID, the host IP addresses, the name of the domain of which the host is a member, and more. See more details in the [Metrics reference](#metrics-reference).
1717

18-
## Requirements
18+
## What do I need to use this integration?
1919

20-
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it.
21-
You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
20+
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
2221

2322
Before using any AWS integration you will need:
2423

2524
* **AWS Credentials** to connect with your AWS account.
2625
* **AWS Permissions** to make sure the user you're using to connect has permission to share the relevant data.
2726

28-
For more details about these requirements, please take a look at the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
27+
For more details about these requirements, refer to the [AWS integration documentation](https://docs.elastic.co/integrations/aws#requirements).
2928

3029
## Setup
3130

@@ -34,7 +33,7 @@ Use this integration if you only need to collect VPN data from AWS.
3433
If you want to collect data from two or more AWS services, consider using the **AWS** integration.
3534
When you configure the AWS integration, you can collect data from as many AWS services as you'd like.
3635

37-
For step-by-step instructions on how to set up an integration, see the
36+
For step-by-step instructions on how to set up an integration, refer to the
3837
[Getting started](https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/getting-started-observability.html) guide.
3938

4039
## Metrics reference
@@ -97,7 +96,7 @@ An example event for `vpn` looks as following:
9796

9897
**ECS Field Reference**
9998

100-
Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
99+
Refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields.
101100

102101
**Exported fields**
103102

0 commit comments

Comments
 (0)