generated from clouddrove/terraform-module-template
-
Notifications
You must be signed in to change notification settings - Fork 4
/
README.yaml
78 lines (66 loc) · 2.18 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: Terraform AWS Security Hub
# License of this project
license: "APACHE"
# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-security-hub
# Badges to display
badges:
- name: "Latest Release"
image: "https://img.shields.io/github/release/clouddrove/clouddrove/terraform-aws-security-hub.svg"
url: "https://github.com/clouddrove/clouddrove/terraform-aws-security-hub/releases/latest"
- name: "tfsec"
image: "https://github.com/clouddrove/clouddrove/terraform-aws-security-hub/actions/workflows/tfsec.yml/badge.svg"
url: "https://github.com/clouddrove/clouddrove/terraform-aws-security-hub/actions/workflows/tfsec.yml"
- name: "Licence"
image: "https://img.shields.io/badge/License-APACHE-blue.svg"
url: "LICENSE.md"
- name: "Changelog"
image: "https://img.shields.io/badge/Changelog-blue"
url: "CHANGELOG.md"
prerequesties:
- name: Terraform
url: https://learn.hashicorp.com/terraform/getting-started/install.html
version: ">= 1.6.6"
providers:
- name: aws
url: https://aws.amazon.com/
version: ">= 5.31.0"
# description of this project
# yamllint disable rule:line-length
description: |-
This terraform module creates set of Security hub.
# How to use this project
# yamllint disable rule:line-length
usage: |-
### Simple Example
Here is an example of how you can use this module in your inventory structure:
```hcl
# use this
module "security_hub" {
source = "clouddrove/security-hub/aws"
version = "1.0.1"
name = "security-hub"
security_hub_enabled = true
#member account add
enable_member_account = true
member_account_id = "123344847783"
member_mail_id = "example@mail.com"
#standards
enabled_standards = [
"standards/aws-foundational-security-best-practices/v/1.0.0",
"ruleset/cis-aws-foundations-benchmark/v/1.2.0"
]
#products
enabled_products = [
"product/aws/guardduty",
"product/aws/inspector",
"product/aws/macie"
]
}
```