|
1 | | -<!-- BEGIN_TF_DOCS --> |
2 | 1 | # Creating modules for AWS I&A Organization |
3 | 2 |
|
4 | 3 | This repo template is used to seed Terraform Module templates for the [AWS I&A GitHub organization](https://github.com/aws-ia). Usage of this template is allowed per included license. PRs to this template will be considered but are not guaranteed to be included. Consider creating an issue to discuss a feature you want to include before taking the time to create a PR. |
@@ -63,31 +62,51 @@ For best practices and information on developing with Terraform, see the [I&A Mo |
63 | 62 |
|
64 | 63 | The I&A team uses AWS CodeBuild to perform continuous integration (CI) within the organization. Our CI uses the a repo's `.pre-commit-config.yaml` file as well as some other checks. All PRs with other CI will be rejected. See our [FAQ](https://aws-ia.github.io/standards-terraform/faq/#are-modules-protected-by-ci-automation) for more details. |
65 | 64 |
|
66 | | -## Requirements |
| 65 | +### Requirements |
67 | 66 |
|
68 | 67 | | Name | Version | |
69 | 68 | |------|---------| |
70 | | -| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.7 | |
71 | | -| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.0.0, < 5.0.0 | |
72 | | -| <a name="requirement_awscc"></a> [awscc](#requirement\_awscc) | >= 0.24.0 | |
| 69 | +| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 | |
| 70 | +| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.47 | |
| 71 | +| <a name="requirement_random"></a> [random](#requirement\_random) | >= 3.4 | |
73 | 72 |
|
74 | | -## Providers |
| 73 | +### Providers |
75 | 74 |
|
76 | | -No providers. |
| 75 | +| Name | Version | |
| 76 | +|------|---------| |
| 77 | +| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.47 | |
77 | 78 |
|
78 | | -## Modules |
| 79 | +### Modules |
79 | 80 |
|
80 | 81 | No modules. |
81 | 82 |
|
82 | | -## Resources |
83 | | - |
84 | | -No resources. |
85 | | - |
86 | | -## Inputs |
87 | | - |
88 | | -No inputs. |
89 | | - |
90 | | -## Outputs |
91 | | - |
92 | | -No outputs. |
93 | | -<!-- END_TF_DOCS --> |
| 83 | +### Resources |
| 84 | + |
| 85 | +| Name | Type | |
| 86 | +|------|------| |
| 87 | +| [aws_route53_health_check.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_health_check) | resource | |
| 88 | +| [aws_shield_protection.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/shield_protection) | resource | |
| 89 | +| [aws_shield_protection_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/shield_protection_group) | resource | |
| 90 | +| [aws_shield_protection_health_check_association.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/shield_protection_health_check_association) | resource | |
| 91 | + |
| 92 | +### Inputs |
| 93 | + |
| 94 | +| Name | Description | Type | Default | Required | |
| 95 | +|------|-------------|------|---------|:--------:| |
| 96 | +| <a name="input_aggregation"></a> [aggregation](#input\_aggregation) | Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events. | `string` | n/a | yes | |
| 97 | +| <a name="input_name"></a> [name](#input\_name) | A friendly name for the Protection you are creating. | `string` | n/a | yes | |
| 98 | +| <a name="input_pattern"></a> [pattern](#input\_pattern) | The criteria to use to choose the protected resources for inclusion in the group. | `string` | n/a | yes | |
| 99 | +| <a name="input_protection_group_id"></a> [protection\_group\_id](#input\_protection\_group\_id) | The name of the protection group. | `string` | n/a | yes | |
| 100 | +| <a name="input_resource_arn"></a> [resource\_arn](#input\_resource\_arn) | The ARN (Amazon Resource Name) of the resource to be protected. | `string` | n/a | yes | |
| 101 | +| <a name="input_health_check_configuration"></a> [health\_check\_configuration](#input\_health\_check\_configuration) | Amazon Route53 Health Check Configuration to be associated to AWS Shield Advanced Protection. | `map(any)` | `null` | no | |
| 102 | +| <a name="input_resource_type"></a> [resource\_type](#input\_resource\_type) | The resource type to include in the protection group. This is required if `pattern` is set to BY\_RESOURCE\_TYPE. Otherwise this must be not set. Defaults to `null` | `string` | `null` | no | |
| 103 | +| <a name="input_tags"></a> [tags](#input\_tags) | Key-value map of resource tags. Defaults to `{}` | `map(string)` | `{}` | no | |
| 104 | + |
| 105 | +### Outputs |
| 106 | + |
| 107 | +| Name | Description | |
| 108 | +|------|-------------| |
| 109 | +| <a name="output_route53_health_check"></a> [route53\_health\_check](#output\_route53\_health\_check) | Amazon Route53 Health Check Configuration. | |
| 110 | +| <a name="output_shied_protection"></a> [shied\_protection](#output\_shied\_protection) | AWS Shield Advanced Protection and assigned resources. | |
| 111 | +| <a name="output_shied_protection_group"></a> [shied\_protection\_group](#output\_shied\_protection\_group) | Group of protected resources to be collectivelly handled by AWS Shield Advanced. | |
| 112 | +| <a name="output_shield_protection_health_check_association"></a> [shield\_protection\_health\_check\_association](#output\_shield\_protection\_health\_check\_association) | Association between an Amazon Route53 Health Check and an AWS Shield Advanced protected resource. | |
0 commit comments