Skip to content

Commit 8a9c27e

Browse files
addressed comments from maintainer.
1 parent 86e8579 commit 8a9c27e

File tree

3 files changed

+56
-49
lines changed

3 files changed

+56
-49
lines changed

README.md

Lines changed: 26 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
21
<!-- markdownlint-disable -->
3-
# terraform-aws-config <a href="https://cpco.io/homepage"><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
2+
# terraform-aws-config <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
43
<a href="https://github.com/cloudposse/terraform-aws-config/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-config.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a><a href="https://ask.sweetops.com/"><img src="https://img.shields.io/discourse/https/ask.sweetops.com/posts.svg" alt="Discourse Forum"/></a>
54
<!-- markdownlint-restore -->
65

@@ -30,9 +29,9 @@ This module enables [AWS Config](https://aws.amazon.com/config/) and optionally
3029

3130
---
3231
> [!NOTE]
33-
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/sweetops) approach towards DevOps.
34-
> <details><summary>Learn More</summary>
35-
> <a href="https://cpco.io/terraform-modules">
32+
> This project is part of Cloud Posse's comprehensive ["SweetOps"](https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=) approach towards DevOps.
33+
> <details><summary><strong>Learn More</strong></summary>
34+
> <a href="https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=terraform_modules">
3635
> <picture>
3736
> <source media="(prefers-color-scheme: dark)" srcset="https://docs.cloudposse.com/images/terraform-open-source-modules-light.svg">
3837
> <source media="(prefers-color-scheme: light)" srcset="https://docs.cloudposse.com/images/terraform-open-source-modules-dark.svg">
@@ -43,10 +42,10 @@ This module enables [AWS Config](https://aws.amazon.com/config/) and optionally
4342
>
4443
> It's 100% Open Source and licensed under the [APACHE2](LICENSE).
4544
>
46-
> We literally have [*hundreds of terraform modules*][terraform_modules] that are Open Source and well-maintained. Check them out!
45+
> We literally have [*hundreds of terraform modules*](https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=terraform_modules) that are Open Source and well-maintained. Check them out!
4746
> </details>
4847
49-
[![README Header][readme_header_img]][readme_header_link]
48+
<a href="https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=readme_header_link"><img src="https://cloudposse.com/readme/header/img"/></a>
5049

5150

5251

@@ -191,6 +190,7 @@ Available targets:
191190
| <a name="input_managed_rules"></a> [managed\_rules](#input\_managed\_rules) | A list of AWS Managed Rules that should be enabled on the account.<br><br>See the following for a list of possible rules to enable:<br>https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html | <pre>map(object({<br> description = string<br> identifier = string<br> input_parameters = any<br> tags = map(string)<br> enabled = bool<br> }))</pre> | `{}` | no |
192191
| <a name="input_name"></a> [name](#input\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br>This is the only ID element not also included as a `tag`.<br>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no |
193192
| <a name="input_namespace"></a> [namespace](#input\_namespace) | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | `string` | `null` | no |
193+
| <a name="input_recording_mode"></a> [recording\_mode](#input\_recording\_mode) | The mode for AWS Config to record configuration changes. <br><br>recording\_frequency:<br>The frequency with which AWS Config records configuration changes (service defaults to CONTINUOUS).<br>- CONTINUOUS<br>- DAILY<br><br>You can also override the recording frequency for specific resource types.<br>recording\_mode\_override:<br> description:<br> A description for the override.<br> recording\_frequency:<br> The frequency with which AWS Config records configuration changes for the specified resource types.<br> - CONTINUOUS<br> - DAILY<br> resource\_types:<br> A list of resource types for which AWS Config records configuration changes. For example, AWS::EC2::Instance.<br><br>See the following for more information:<br>https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html<br><br>/*<br>recording\_mode = {<br> recording\_frequency = "DAILY"<br> recording\_mode\_override = {<br> description = "Override for specific resource types"<br> recording\_frequency = "CONTINUOUS"<br> resource\_types = ["AWS::EC2::Instance"]<br> }<br>}<br>*/ | <pre>object({<br> recording_frequency = string<br> recording_mode_override = optional(object({<br> description = string<br> recording_frequency = string<br> resource_types = list(string)<br> }))<br> })</pre> | `null` | no |
194194
| <a name="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no |
195195
| <a name="input_s3_bucket_arn"></a> [s3\_bucket\_arn](#input\_s3\_bucket\_arn) | The ARN of the S3 bucket used to store the configuration history | `string` | n/a | yes |
196196
| <a name="input_s3_bucket_id"></a> [s3\_bucket\_id](#input\_s3\_bucket\_id) | The id (name) of the S3 bucket used to store the configuration history | `string` | n/a | yes |
@@ -249,7 +249,7 @@ Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-confi
249249
### 💻 Developing
250250

251251
If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you!
252-
Hit us up in [Slack][slack], in the `#cloudposse` channel.
252+
Hit us up in [Slack](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=slack), in the `#cloudposse` channel.
253253

254254
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
255255
1. Review our [Code of Conduct](https://github.com/cloudposse/terraform-aws-config/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
@@ -263,35 +263,35 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
263263

264264
### 🌎 Slack Community
265265

266-
Join our [Open Source Community][slack] on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.
266+
Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=slack) on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.
267267

268268
### 📰 Newsletter
269269

270-
Sign up for [our newsletter][newsletter] and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know.
270+
Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=newsletter) and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know.
271271
Dropped straight into your Inbox every week — and usually a 5-minute read.
272272

273-
### 📆 Office Hours <img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" />
273+
### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>
274274

275-
[Join us every Wednesday via Zoom][office_hours] for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q&A_ that you can’t find anywhere else.
275+
[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=office_hours) for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q&A_ that you can’t find anywhere else.
276276
It's **FREE** for everyone!
277277

278278
## About
279279

280-
This project is maintained by [Cloud Posse, LLC][website].
281-
<a href="https://cpco.io/homepage"><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
280+
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=">Cloud Posse, LLC</a>.
281+
<a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
282282

283-
We are a [**DevOps Accelerator**][commercial_support] for funded startups and enterprises.
283+
We are a [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=commercial_support) for funded startups and enterprises.
284284
Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
285285
We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
286286

287-
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
287+
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
288288

289289
*Your team can operate like a pro today.*
290290

291291
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
292292

293293
<details>
294-
<summary>📚 <strong>What's included?</strong></summary>
294+
<summary>📚 <strong>See What's Included</strong></summary>
295295

296296
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
297297
- **Deployment Strategy.** You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
@@ -305,16 +305,18 @@ Ensure that your team succeeds by using our proven process and turnkey blueprint
305305
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
306306
</details>
307307

308-
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
308+
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
309309
## License
310310

311-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)
311+
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>
312312

313313
<details>
314314
<summary>Preamble to the Apache License, Version 2.0</summary>
315315
<br/>
316316
<br/>
317+
317318
Complete license is available in the [`LICENSE`](LICENSE) file.
319+
318320
```text
319321
Licensed to the Apache Software Foundation (ASF) under one
320322
or more contributor license agreements. See the NOTICE file
@@ -342,28 +344,8 @@ All other trademarks referenced herein are the property of their respective owne
342344

343345
Copyright © 2021-2024 [Cloud Posse, LLC](https://cloudposse.com)
344346

345-
[![README Footer][readme_footer_img]][readme_footer_link]
346-
[![Beacon][beacon]][website]
347-
<!-- markdownlint-disable -->
348-
[logo]: https://cloudposse.com/logo-300x69.svg
349-
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=docs
350-
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=website
351-
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=github
352-
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=jobs
353-
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=hire
354-
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=slack
355-
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=twitter
356-
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=office_hours
357-
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=newsletter
358-
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=email
359-
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=commercial_support
360-
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=we_love_open_source
361-
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=terraform_modules
362-
[readme_header_img]: https://cloudposse.com/readme/header/img
363-
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=readme_header_link
364-
[readme_footer_img]: https://cloudposse.com/readme/footer/img
365-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=readme_footer_link
366-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
367-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=readme_commercial_support_link
368-
[beacon]: https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-aws-config?pixel&cs=github&cm=readme&an=terraform-aws-config
369-
<!-- markdownlint-restore -->
347+
348+
349+
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-config&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
350+
351+
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-aws-config?pixel&cs=github&cm=readme&an=terraform-aws-config"/>

docs/terraform.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@
7979
| <a name="input_managed_rules"></a> [managed\_rules](#input\_managed\_rules) | A list of AWS Managed Rules that should be enabled on the account.<br><br>See the following for a list of possible rules to enable:<br>https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html | <pre>map(object({<br> description = string<br> identifier = string<br> input_parameters = any<br> tags = map(string)<br> enabled = bool<br> }))</pre> | `{}` | no |
8080
| <a name="input_name"></a> [name](#input\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br>This is the only ID element not also included as a `tag`.<br>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no |
8181
| <a name="input_namespace"></a> [namespace](#input\_namespace) | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | `string` | `null` | no |
82+
| <a name="input_recording_mode"></a> [recording\_mode](#input\_recording\_mode) | The mode for AWS Config to record configuration changes. <br><br>recording\_frequency:<br>The frequency with which AWS Config records configuration changes (service defaults to CONTINUOUS).<br>- CONTINUOUS<br>- DAILY<br><br>You can also override the recording frequency for specific resource types.<br>recording\_mode\_override:<br> description:<br> A description for the override.<br> recording\_frequency:<br> The frequency with which AWS Config records configuration changes for the specified resource types.<br> - CONTINUOUS<br> - DAILY<br> resource\_types:<br> A list of resource types for which AWS Config records configuration changes. For example, AWS::EC2::Instance.<br><br>See the following for more information:<br>https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html<br><br>/*<br>recording\_mode = {<br> recording\_frequency = "DAILY"<br> recording\_mode\_override = {<br> description = "Override for specific resource types"<br> recording\_frequency = "CONTINUOUS"<br> resource\_types = ["AWS::EC2::Instance"]<br> }<br>}<br>*/ | <pre>object({<br> recording_frequency = string<br> recording_mode_override = optional(object({<br> description = string<br> recording_frequency = string<br> resource_types = list(string)<br> }))<br> })</pre> | `null` | no |
8283
| <a name="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no |
8384
| <a name="input_s3_bucket_arn"></a> [s3\_bucket\_arn](#input\_s3\_bucket\_arn) | The ARN of the S3 bucket used to store the configuration history | `string` | n/a | yes |
8485
| <a name="input_s3_bucket_id"></a> [s3\_bucket\_id](#input\_s3\_bucket\_id) | The id (name) of the S3 bucket used to store the configuration history | `string` | n/a | yes |

0 commit comments

Comments
 (0)