Skip to content

Commit ec77fbd

Browse files
authored
feat: prettier in READMEs (cloudposse/terraform-aws-components#998)
1 parent c535a4f commit ec77fbd

File tree

2 files changed

+23
-20
lines changed

2 files changed

+23
-20
lines changed

src/CHANGELOG.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,20 @@
22

33
### Possible Breaking Change
44

5-
The `module "datadog_integration"` and `module "store_write"` had been changed
6-
in an earlier PR from a module without a `count`
7-
to a module with a `count` of zero or one. This PR changes it back to a module
8-
without a count. If you were using the module with a `count` of zero or one,
9-
applying this new version will cause it be destroyed and recreated. This should only
10-
cause a very brief outage in your Datadog monitoring.
5+
The `module "datadog_integration"` and `module "store_write"` had been changed in an earlier PR from a module without a
6+
`count` to a module with a `count` of zero or one. This PR changes it back to a module without a count. If you were
7+
using the module with a `count` of zero or one, applying this new version will cause it be destroyed and recreated. This
8+
should only cause a very brief outage in your Datadog monitoring.
119

1210
### New Integration Options
1311

1412
This PR adds the following new integration options:
1513

16-
- `cspm_resource_collection_enabled` - Enable Datadog Cloud Security Posture Management scanning of your AWS account. See [announcement](https://www.datadoghq.com/product/cloud-security-management/cloud-security-posture-management/) for details.
17-
- `metrics_collection_enabled` - When enabled, a metric-by-metric crawl of the CloudWatch API pulls data and sends it
18-
to Datadog. New metrics are pulled every ten minutes, on average.
19-
- `resource_collection_enabled` - Some Datadog products leverage information about how your AWS resources (
20-
such as S3 Buckets, RDS snapshots, and CloudFront distributions) are configured.
21-
When `resource_collection_enabled` is `true`, Datadog collects this information
22-
by making read-only API calls into your AWS account.
14+
- `cspm_resource_collection_enabled` - Enable Datadog Cloud Security Posture Management scanning of your AWS account.
15+
See [announcement](https://www.datadoghq.com/product/cloud-security-management/cloud-security-posture-management/) for
16+
details.
17+
- `metrics_collection_enabled` - When enabled, a metric-by-metric crawl of the CloudWatch API pulls data and sends it to
18+
Datadog. New metrics are pulled every ten minutes, on average.
19+
- `resource_collection_enabled` - Some Datadog products leverage information about how your AWS resources ( such as S3
20+
Buckets, RDS snapshots, and CloudFront distributions) are configured. When `resource_collection_enabled` is `true`,
21+
Datadog collects this information by making read-only API calls into your AWS account.

src/README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
# Component: `datadog-integration`
22

3-
This component is responsible for provisioning Datadog AWS integrations. It depends on
4-
the `datadog-configuration` component to get the Datadog API keys.
3+
This component is responsible for provisioning Datadog AWS integrations. It depends on the `datadog-configuration`
4+
component to get the Datadog API keys.
55

6-
See Datadog's [documentation about provisioning keys](https://docs.datadoghq.com/account_management/api-app-keys) for more information.
6+
See Datadog's [documentation about provisioning keys](https://docs.datadoghq.com/account_management/api-app-keys) for
7+
more information.
78

89
## Usage
910

1011
**Stack Level**: Global
1112

12-
Here's an example snippet for how to use this component. It's suggested to apply this component to all accounts which you want to track AWS metrics with DataDog.
13+
Here's an example snippet for how to use this component. It's suggested to apply this component to all accounts which
14+
you want to track AWS metrics with DataDog.
1315

1416
```yaml
1517
components:
@@ -22,6 +24,7 @@ components:
2224
enabled: true
2325
```
2426
27+
<!-- prettier-ignore-start -->
2528
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
2629
## Requirements
2730
@@ -96,11 +99,12 @@ components:
9699
| <a name="output_aws_role_name"></a> [aws\_role\_name](#output\_aws\_role\_name) | Name of the AWS IAM Role for the Datadog integration |
97100
| <a name="output_datadog_external_id"></a> [datadog\_external\_id](#output\_datadog\_external\_id) | Datadog integration external ID |
98101
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
99-
102+
<!-- prettier-ignore-end -->
100103

101104
## References
102-
* Datadog's [documentation about provisioning keys](https://docs.datadoghq.com/account_management/api-app-keys)
103-
* [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/datadog-integration) - Cloud Posse's upstream component
104105

106+
- Datadog's [documentation about provisioning keys](https://docs.datadoghq.com/account_management/api-app-keys)
107+
- [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/datadog-integration) -
108+
Cloud Posse's upstream component
105109

106110
[<img src="https://cloudposse.com/logo-300x69.svg" height="32" align="right"/>](https://cpco.io/component)

0 commit comments

Comments
 (0)