Skip to content

Commit

Permalink
Update README files
Browse files Browse the repository at this point in the history
  • Loading branch information
@snemetz
snemetz committed Feb 28, 2022
1 parent dda2bb8 commit e989da3
Showing 1 changed file with 60 additions and 60 deletions.
120 changes: 60 additions & 60 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,39 +25,39 @@ This module is composed of several submodules and each of which can be used inde

| Name | Version |
|------|---------|
| terraform | >= 1.1.4 |
| aws | >= 4.1.0 |
| time | >= 0.7.2 |
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.1.4 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.1.0 |
| <a name="requirement_time"></a> [time](#requirement\_time) | >= 0.7.2 |

## Providers

| Name | Version |
|------|---------|
| aws | 4.2.0 |
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.2.0 |

## Modules

| Name | Source | Version |
|------|--------|---------|
| baseline\_ebs\_eu-west-1 | ./modules/baseline_ebs | n/a |
| baseline\_ebs\_us-east-1 | ./modules/baseline_ebs | n/a |
| baseline\_ebs\_us-east-2 | ./modules/baseline_ebs | n/a |
| baseline\_ecr\_eu-west-1 | ./modules/baseline_ecr | n/a |
| baseline\_ecr\_us-east-1 | ./modules/baseline_ecr | n/a |
| baseline\_ecr\_us-east-2 | ./modules/baseline_ecr | n/a |
| baseline\_iam | ./modules/baseline_iam | n/a |
| baseline\_s3 | ./modules/baseline_s3 | n/a |
| firewall\_manager\_us-east-1 | ./modules/firewall_manager | n/a |
| guardduty-eu-west-1 | ./modules/guardduty | n/a |
| guardduty-us-east-1 | ./modules/guardduty | n/a |
| guardduty-us-east-2 | ./modules/guardduty | n/a |
| iam\_access\_analyzer-eu-west-1 | ./modules/iam_access_analyzer | n/a |
| iam\_access\_analyzer-us-east-1 | ./modules/iam_access_analyzer | n/a |
| iam\_access\_analyzer-us-east-2 | ./modules/iam_access_analyzer | n/a |
| s3\_bucket-us-east-1 | ./modules/s3_bucket | n/a |
| securityhub\_eu-west-1 | ./modules/securityhub | n/a |
| securityhub\_us-east-1 | ./modules/securityhub | n/a |
| securityhub\_us-east-2 | ./modules/securityhub | n/a |
| <a name="module_baseline_ebs_eu-west-1"></a> [baseline\_ebs\_eu-west-1](#module\_baseline\_ebs\_eu-west-1) | ./modules/baseline_ebs | n/a |
| <a name="module_baseline_ebs_us-east-1"></a> [baseline\_ebs\_us-east-1](#module\_baseline\_ebs\_us-east-1) | ./modules/baseline_ebs | n/a |
| <a name="module_baseline_ebs_us-east-2"></a> [baseline\_ebs\_us-east-2](#module\_baseline\_ebs\_us-east-2) | ./modules/baseline_ebs | n/a |
| <a name="module_baseline_ecr_eu-west-1"></a> [baseline\_ecr\_eu-west-1](#module\_baseline\_ecr\_eu-west-1) | ./modules/baseline_ecr | n/a |
| <a name="module_baseline_ecr_us-east-1"></a> [baseline\_ecr\_us-east-1](#module\_baseline\_ecr\_us-east-1) | ./modules/baseline_ecr | n/a |
| <a name="module_baseline_ecr_us-east-2"></a> [baseline\_ecr\_us-east-2](#module\_baseline\_ecr\_us-east-2) | ./modules/baseline_ecr | n/a |
| <a name="module_baseline_iam"></a> [baseline\_iam](#module\_baseline\_iam) | ./modules/baseline_iam | n/a |
| <a name="module_baseline_s3"></a> [baseline\_s3](#module\_baseline\_s3) | ./modules/baseline_s3 | n/a |
| <a name="module_firewall_manager_us-east-1"></a> [firewall\_manager\_us-east-1](#module\_firewall\_manager\_us-east-1) | ./modules/firewall_manager | n/a |
| <a name="module_guardduty-eu-west-1"></a> [guardduty-eu-west-1](#module\_guardduty-eu-west-1) | ./modules/guardduty | n/a |
| <a name="module_guardduty-us-east-1"></a> [guardduty-us-east-1](#module\_guardduty-us-east-1) | ./modules/guardduty | n/a |
| <a name="module_guardduty-us-east-2"></a> [guardduty-us-east-2](#module\_guardduty-us-east-2) | ./modules/guardduty | n/a |
| <a name="module_iam_access_analyzer-eu-west-1"></a> [iam\_access\_analyzer-eu-west-1](#module\_iam\_access\_analyzer-eu-west-1) | ./modules/iam_access_analyzer | n/a |
| <a name="module_iam_access_analyzer-us-east-1"></a> [iam\_access\_analyzer-us-east-1](#module\_iam\_access\_analyzer-us-east-1) | ./modules/iam_access_analyzer | n/a |
| <a name="module_iam_access_analyzer-us-east-2"></a> [iam\_access\_analyzer-us-east-2](#module\_iam\_access\_analyzer-us-east-2) | ./modules/iam_access_analyzer | n/a |
| <a name="module_s3_bucket-us-east-1"></a> [s3\_bucket-us-east-1](#module\_s3\_bucket-us-east-1) | ./modules/s3_bucket | n/a |
| <a name="module_securityhub_eu-west-1"></a> [securityhub\_eu-west-1](#module\_securityhub\_eu-west-1) | ./modules/securityhub | n/a |
| <a name="module_securityhub_us-east-1"></a> [securityhub\_us-east-1](#module\_securityhub\_us-east-1) | ./modules/securityhub | n/a |
| <a name="module_securityhub_us-east-2"></a> [securityhub\_us-east-2](#module\_securityhub\_us-east-2) | ./modules/securityhub | n/a |

## Resources

Expand All @@ -70,43 +70,43 @@ This module is composed of several submodules and each of which can be used inde

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| account\_type | AWS account type (master, administrator, member) | `string` | n/a | yes |
| aws\_profile | AWS credential profile | `string` | n/a | yes |
| aws\_region | The AWS region in which global resources are set up. | `string` | `"us-east-1"` | no |
| bucket\_custom\_policy\_json | Custom S3 bucket policy override JSON | `string` | `""` | no |
| cloudtrail\_s3\_key\_prefix | S3 key prefix for CloudTrail | `string` | `"cloudtrail"` | no |
| config\_s3\_bucket\_key\_prefix | S3 key prefix for Config | `string` | `"config"` | no |
| ecr\_scan\_type | ECR scanning type (BASIC or ENHANCED) | `string` | `"BASIC"` | no |
| ecr\_scanning\_rules | List of ECR scanning rules | `list(map(string))` | ```[ { "filter": "*", "frequency": "SCAN_ON_PUSH" } ]``` | no |
| enable\_cloudtrail | Enable AWS CloudTrail service | `bool` | `true` | no |
| enable\_config | Enable AWS Config service | `bool` | `true` | no |
| enable\_ebs\_baseline | Boolean whether iam-baseline is enabled. | `bool` | `true` | no |
| enable\_ecr\_baseline | Enable ECR image scanning | `bool` | `true` | no |
| enable\_firewall\_manager | Enable AWS Firewall Manager service | `bool` | `true` | no |
| enable\_guardduty | Enable AWS GuardDuty service | `bool` | `true` | no |
| enable\_iam\_access\_analyzer | Enable AWS IAM Access Analyzer | `bool` | `true` | no |
| enable\_iam\_baseline | Boolean whether iam-baseline is enabled. | `bool` | `true` | no |
| enable\_s3\_baseline | Enable S3 baseline? | `bool` | `true` | no |
| enable\_s3\_buckets | Enable S3 buckets? | `bool` | `false` | no |
| enable\_securityhub | Enable AWS Security Hub service | `bool` | `true` | no |
| force\_destroy | Allow destroy of S3 bucket with objects | `bool` | `false` | no |
| iam\_allow\_users\_to\_change\_password | Whether to allow users to change their own password. | `bool` | `true` | no |
| iam\_create\_password\_policy | Define if the password policy should be created. | `bool` | `true` | no |
| iam\_max\_password\_age | The number of days that an user password is valid. | `number` | `0` | no |
| iam\_minimum\_password\_length | Minimum length to require for user passwords. | `number` | `14` | no |
| iam\_password\_reuse\_prevention | The number of previous passwords that users are prevented from reusing. | `number` | `24` | no |
| iam\_require\_lowercase\_characters | Whether to require lowercase characters for user passwords. | `bool` | `true` | no |
| iam\_require\_numbers | Whether to require numbers for user passwords. | `bool` | `true` | no |
| iam\_require\_symbols | Whether to require symbols for user passwords. | `bool` | `true` | no |
| iam\_require\_uppercase\_characters | Whether to require uppercase characters for user passwords. | `bool` | `true` | no |
| s3\_block\_public\_acls | Whether Amazon S3 should block public ACLs for buckets in this account. Defaults to true. | `bool` | `true` | no |
| s3\_block\_public\_policy | Whether Amazon S3 should block public bucket policies for buckets in this account. Defaults to true. | `bool` | `true` | no |
| s3\_ignore\_public\_acls | Whether Amazon S3 should ignore public ACLs for buckets in this account. Defaults to true. | `bool` | `true` | no |
| s3\_restrict\_public\_buckets | Whether Amazon S3 should restrict public bucket policies for buckets in this account. Defaults to true. | `bool` | `true` | no |
| security\_administrator\_account\_id | AWS Security Administrator Account ID | `number` | n/a | yes |
| tags | Specifies object tags key and value. This applies to all resources created by this module. | `map` | ```{ "Environment": "infra", "Product": "security", "Team": "devops", "Terraform": true }``` | no |
| target\_regions | A list of regions to set up with this module. | `list` | ```[ "eu-west-1", "us-east-1", "us-east-2" ]``` | no |
| vpc\_flow\_logs\_s3\_key\_prefix | S3 key prefix for VPC Flow Logs | `string` | `"flow-logs"` | no |
| <a name="input_account_type"></a> [account\_type](#input\_account\_type) | AWS account type (master, administrator, member) | `string` | n/a | yes |
| <a name="input_aws_profile"></a> [aws\_profile](#input\_aws\_profile) | AWS credential profile | `string` | n/a | yes |
| <a name="input_aws_region"></a> [aws\_region](#input\_aws\_region) | The AWS region in which global resources are set up. | `string` | `"us-east-1"` | no |
| <a name="input_bucket_custom_policy_json"></a> [bucket\_custom\_policy\_json](#input\_bucket\_custom\_policy\_json) | Custom S3 bucket policy override JSON | `string` | `""` | no |
| <a name="input_cloudtrail_s3_key_prefix"></a> [cloudtrail\_s3\_key\_prefix](#input\_cloudtrail\_s3\_key\_prefix) | S3 key prefix for CloudTrail | `string` | `"cloudtrail"` | no |
| <a name="input_config_s3_bucket_key_prefix"></a> [config\_s3\_bucket\_key\_prefix](#input\_config\_s3\_bucket\_key\_prefix) | S3 key prefix for Config | `string` | `"config"` | no |
| <a name="input_ecr_scan_type"></a> [ecr\_scan\_type](#input\_ecr\_scan\_type) | ECR scanning type (BASIC or ENHANCED) | `string` | `"BASIC"` | no |
| <a name="input_ecr_scanning_rules"></a> [ecr\_scanning\_rules](#input\_ecr\_scanning\_rules) | List of ECR scanning rules | `list(map(string))` | <pre>[<br> {<br> "filter": "*",<br> "frequency": "SCAN_ON_PUSH"<br> }<br>]</pre> | no |
| <a name="input_enable_cloudtrail"></a> [enable\_cloudtrail](#input\_enable\_cloudtrail) | Enable AWS CloudTrail service | `bool` | `true` | no |
| <a name="input_enable_config"></a> [enable\_config](#input\_enable\_config) | Enable AWS Config service | `bool` | `true` | no |
| <a name="input_enable_ebs_baseline"></a> [enable\_ebs\_baseline](#input\_enable\_ebs\_baseline) | Boolean whether iam-baseline is enabled. | `bool` | `true` | no |
| <a name="input_enable_ecr_baseline"></a> [enable\_ecr\_baseline](#input\_enable\_ecr\_baseline) | Enable ECR image scanning | `bool` | `true` | no |
| <a name="input_enable_firewall_manager"></a> [enable\_firewall\_manager](#input\_enable\_firewall\_manager) | Enable AWS Firewall Manager service | `bool` | `true` | no |
| <a name="input_enable_guardduty"></a> [enable\_guardduty](#input\_enable\_guardduty) | Enable AWS GuardDuty service | `bool` | `true` | no |
| <a name="input_enable_iam_access_analyzer"></a> [enable\_iam\_access\_analyzer](#input\_enable\_iam\_access\_analyzer) | Enable AWS IAM Access Analyzer | `bool` | `true` | no |
| <a name="input_enable_iam_baseline"></a> [enable\_iam\_baseline](#input\_enable\_iam\_baseline) | Boolean whether iam-baseline is enabled. | `bool` | `true` | no |
| <a name="input_enable_s3_baseline"></a> [enable\_s3\_baseline](#input\_enable\_s3\_baseline) | Enable S3 baseline? | `bool` | `true` | no |
| <a name="input_enable_s3_buckets"></a> [enable\_s3\_buckets](#input\_enable\_s3\_buckets) | Enable S3 buckets? | `bool` | `false` | no |
| <a name="input_enable_securityhub"></a> [enable\_securityhub](#input\_enable\_securityhub) | Enable AWS Security Hub service | `bool` | `true` | no |
| <a name="input_force_destroy"></a> [force\_destroy](#input\_force\_destroy) | Allow destroy of S3 bucket with objects | `bool` | `false` | no |
| <a name="input_iam_allow_users_to_change_password"></a> [iam\_allow\_users\_to\_change\_password](#input\_iam\_allow\_users\_to\_change\_password) | Whether to allow users to change their own password. | `bool` | `true` | no |
| <a name="input_iam_create_password_policy"></a> [iam\_create\_password\_policy](#input\_iam\_create\_password\_policy) | Define if the password policy should be created. | `bool` | `true` | no |
| <a name="input_iam_max_password_age"></a> [iam\_max\_password\_age](#input\_iam\_max\_password\_age) | The number of days that an user password is valid. | `number` | `0` | no |
| <a name="input_iam_minimum_password_length"></a> [iam\_minimum\_password\_length](#input\_iam\_minimum\_password\_length) | Minimum length to require for user passwords. | `number` | `14` | no |
| <a name="input_iam_password_reuse_prevention"></a> [iam\_password\_reuse\_prevention](#input\_iam\_password\_reuse\_prevention) | The number of previous passwords that users are prevented from reusing. | `number` | `24` | no |
| <a name="input_iam_require_lowercase_characters"></a> [iam\_require\_lowercase\_characters](#input\_iam\_require\_lowercase\_characters) | Whether to require lowercase characters for user passwords. | `bool` | `true` | no |
| <a name="input_iam_require_numbers"></a> [iam\_require\_numbers](#input\_iam\_require\_numbers) | Whether to require numbers for user passwords. | `bool` | `true` | no |
| <a name="input_iam_require_symbols"></a> [iam\_require\_symbols](#input\_iam\_require\_symbols) | Whether to require symbols for user passwords. | `bool` | `true` | no |
| <a name="input_iam_require_uppercase_characters"></a> [iam\_require\_uppercase\_characters](#input\_iam\_require\_uppercase\_characters) | Whether to require uppercase characters for user passwords. | `bool` | `true` | no |
| <a name="input_s3_block_public_acls"></a> [s3\_block\_public\_acls](#input\_s3\_block\_public\_acls) | Whether Amazon S3 should block public ACLs for buckets in this account. Defaults to true. | `bool` | `true` | no |
| <a name="input_s3_block_public_policy"></a> [s3\_block\_public\_policy](#input\_s3\_block\_public\_policy) | Whether Amazon S3 should block public bucket policies for buckets in this account. Defaults to true. | `bool` | `true` | no |
| <a name="input_s3_ignore_public_acls"></a> [s3\_ignore\_public\_acls](#input\_s3\_ignore\_public\_acls) | Whether Amazon S3 should ignore public ACLs for buckets in this account. Defaults to true. | `bool` | `true` | no |
| <a name="input_s3_restrict_public_buckets"></a> [s3\_restrict\_public\_buckets](#input\_s3\_restrict\_public\_buckets) | Whether Amazon S3 should restrict public bucket policies for buckets in this account. Defaults to true. | `bool` | `true` | no |
| <a name="input_security_administrator_account_id"></a> [security\_administrator\_account\_id](#input\_security\_administrator\_account\_id) | AWS Security Administrator Account ID | `number` | n/a | yes |
| <a name="input_tags"></a> [tags](#input\_tags) | Specifies object tags key and value. This applies to all resources created by this module. | `map` | <pre>{<br> "Environment": "infra",<br> "Product": "security",<br> "Team": "devops",<br> "Terraform": true<br>}</pre> | no |
| <a name="input_target_regions"></a> [target\_regions](#input\_target\_regions) | A list of regions to set up with this module. | `list` | <pre>[<br> "eu-west-1",<br> "us-east-1",<br> "us-east-2"<br>]</pre> | no |
| <a name="input_vpc_flow_logs_s3_key_prefix"></a> [vpc\_flow\_logs\_s3\_key\_prefix](#input\_vpc\_flow\_logs\_s3\_key\_prefix) | S3 key prefix for VPC Flow Logs | `string` | `"flow-logs"` | no |

## Outputs

Expand Down

0 comments on commit e989da3

Please sign in to comment.