Skip to content

Commit ef1c928

Browse files
aknyshaknysh
authored
Add aws-shield component (#670)
1 parent 09f4a0b commit ef1c928

File tree

11 files changed

+610
-0
lines changed

11 files changed

+610
-0
lines changed

‎modules/aws-shield/README.md‎

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
# Component: `aws-shield`
2+
3+
This component is responsible for enabling AWS Shield Advanced Protection for the following resources:
4+
5+
* Application Load Balancers (ALBs)
6+
* CloudFront Distributions
7+
* Elastic IPs
8+
* Route53 Hosted Zones
9+
10+
This component assumes that resources it is configured to protect are not already protected by other components
11+
that have their `xxx_aws_shield_protection_enabled` variable set to `true`.
12+
13+
This component also requires that the account where the component is being provisioned to has
14+
been [subscribed to AWS Shield Advanced](https://docs.aws.amazon.com/waf/latest/developerguide/enable-ddos-prem.html).
15+
16+
## Usage
17+
18+
**Stack Level**: Global or Regional
19+
20+
The following snippet shows how to use all of this component's features in a stack configuration:
21+
22+
```yaml
23+
components:
24+
terraform:
25+
aws-shield:
26+
settings:
27+
spacelift:
28+
workspace_enabled: true
29+
vars:
30+
enabled: true
31+
route53_zone_names:
32+
- test.ue1.example.net
33+
alb_names:
34+
- k8s-common-2c5f23ff99
35+
cloudfront_distribution_ids:
36+
- EDFDVBD632BHDS5
37+
eips:
38+
- 3.214.128.240
39+
- 35.172.208.150
40+
- 35.171.70.50
41+
```
42+
43+
A typical global configuration will only include the `route53_zone_names` and `cloudfront_distribution_ids` variables,
44+
as global Route53 Hosted Zones may exist in that account, and because CloudFront is a global AWS service.
45+
46+
A global stack configuration will not have a VPC, and hence `alb_names` and `eips` should not be defined:
47+
48+
```yaml
49+
components:
50+
terraform:
51+
aws-shield:
52+
settings:
53+
spacelift:
54+
workspace_enabled: true
55+
vars:
56+
enabled: true
57+
route53_zone_names:
58+
- test.example.net
59+
cloudfront_distribution_ids:
60+
- EDFDVBD632BHDS5
61+
```
62+
63+
Regional stack configurations will typically make use of all resources except for `cloudfront_distribution_ids`:
64+
65+
```yaml
66+
components:
67+
terraform:
68+
aws-shield:
69+
settings:
70+
spacelift:
71+
workspace_enabled: true
72+
vars:
73+
route53_zone_names:
74+
- test.ue1.example.net
75+
alb_names:
76+
- k8s-common-2c5f23ff99
77+
eips:
78+
- 3.214.128.240
79+
- 35.172.208.150
80+
- 35.171.70.50
81+
```
82+
83+
Stack configurations which rely on components with a `xxx_aws_shield_protection_enabled` variable should set that variable to `true`
84+
and leave the corresponding variable for this component as empty, relying on that component's AWS Shield Advanced functionality instead.
85+
This leads to more simplified inter-component dependencies and minimizes the need for maintaining the provisioning order during a cold-start.
86+
87+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
88+
## Requirements
89+
90+
| Name | Version |
91+
|------|---------|
92+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
93+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.0 |
94+
95+
## Providers
96+
97+
| Name | Version |
98+
|------|---------|
99+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.0 |
100+
101+
## Modules
102+
103+
| Name | Source | Version |
104+
|------|--------|---------|
105+
| <a name="module_iam_roles"></a> [iam\_roles](#module\_iam\_roles) | ../account-map/modules/iam-roles | n/a |
106+
| <a name="module_this"></a> [this](#module\_this) | cloudposse/label/null | 0.25.0 |
107+
108+
## Resources
109+
110+
| Name | Type |
111+
|------|------|
112+
| [aws_shield_protection.alb_shield_protection](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/shield_protection) | resource |
113+
| [aws_shield_protection.cloudfront_shield_protection](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/shield_protection) | resource |
114+
| [aws_shield_protection.eip_shield_protection](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/shield_protection) | resource |
115+
| [aws_shield_protection.route53_zone_protection](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/shield_protection) | resource |
116+
| [aws_alb.alb](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/alb) | data source |
117+
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
118+
| [aws_cloudfront_distribution.cloudfront_distribution](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/cloudfront_distribution) | data source |
119+
| [aws_eip.eip](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/eip) | data source |
120+
| [aws_partition.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/partition) | data source |
121+
| [aws_route53_zone.route53_zone](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route53_zone) | data source |
122+
123+
## Inputs
124+
125+
| Name | Description | Type | Default | Required |
126+
|------|-------------|------|---------|:--------:|
127+
| <a name="input_additional_tag_map"></a> [additional\_tag\_map](#input\_additional\_tag\_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no |
128+
| <a name="input_alb_names"></a> [alb\_names](#input\_alb\_names) | list of ALB names which will be protected with AWS Shield Advanced | `list(string)` | `[]` | no |
129+
| <a name="input_attributes"></a> [attributes](#input\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the `delimiter`<br>and treated as a single ID element. | `list(string)` | `[]` | no |
130+
| <a name="input_cloudfront_distribution_ids"></a> [cloudfront\_distribution\_ids](#input\_cloudfront\_distribution\_ids) | list of CloudFront Distribution IDs which will be protected with AWS Shield Advanced | `list(string)` | `[]` | no |
131+
| <a name="input_context"></a> [context](#input\_context) | Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | <pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "descriptor_formats": {},<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "labels_as_tags": [<br> "unset"<br> ],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {},<br> "tenant": null<br>}</pre> | no |
132+
| <a name="input_delimiter"></a> [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.<br>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no |
133+
| <a name="input_descriptor_formats"></a> [descriptor\_formats](#input\_descriptor\_formats) | Describe additional descriptors to be output in the `descriptors` output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>`{<br> format = string<br> labels = list(string)<br>}`<br>(Type is `any` so the map values can later be enhanced to provide additional options.)<br>`format` is a Terraform format string to be passed to the `format()` function.<br>`labels` is a list of labels, in order, to pass to `format()` function.<br>Label values will be normalized before being passed to `format()` so they will be<br>identical to how they appear in `id`.<br>Default is `{}` (`descriptors` output will be empty). | `any` | `{}` | no |
134+
| <a name="input_eips"></a> [eips](#input\_eips) | List of Elastic IPs which will be protected with AWS Shield Advanced | `list(string)` | `[]` | no |
135+
| <a name="input_enabled"></a> [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |
136+
| <a name="input_environment"></a> [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |
137+
| <a name="input_id_length_limit"></a> [id\_length\_limit](#input\_id\_length\_limit) | Limit `id` to this many characters (minimum 6).<br>Set to `0` for unlimited length.<br>Set to `null` for keep the existing setting, which defaults to `0`.<br>Does not affect `id_full`. | `number` | `null` | no |
138+
| <a name="input_import_profile_name"></a> [import\_profile\_name](#input\_import\_profile\_name) | AWS Profile name to use when importing a resource | `string` | `null` | no |
139+
| <a name="input_import_role_arn"></a> [import\_role\_arn](#input\_import\_role\_arn) | IAM Role ARN to use when importing a resource | `string` | `null` | no |
140+
| <a name="input_label_key_case"></a> [label\_key\_case](#input\_label\_key\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br>Does not affect keys of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper`.<br>Default value: `title`. | `string` | `null` | no |
141+
| <a name="input_label_order"></a> [label\_order](#input\_label\_order) | The order in which the labels (ID elements) appear in the `id`.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | `list(string)` | `null` | no |
142+
| <a name="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of ID elements (labels) as included in `id`,<br>set as tag values, and output by this module individually.<br>Does not affect values of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br>Default value: `lower`. | `string` | `null` | no |
143+
| <a name="input_labels_as_tags"></a> [labels\_as\_tags](#input\_labels\_as\_tags) | Set of labels (ID elements) to include as tags in the `tags` output.<br>Default is to include all labels.<br>Tags with empty values will not be included in the `tags` output.<br>Set to `[]` to suppress all generated tags.<br>**Notes:**<br> The value of the `name` tag, if included, will be the `id`, not the `name`.<br> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br> changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | <pre>[<br> "default"<br>]</pre> | no |
144+
| <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 |
145+
| <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 |
146+
| <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 |
147+
| <a name="input_region"></a> [region](#input\_region) | AWS Region | `string` | n/a | yes |
148+
| <a name="input_route53_zone_names"></a> [route53\_zone\_names](#input\_route53\_zone\_names) | List of Route53 Hosted Zone names which will be protected with AWS Shield Advanced | `list(string)` | `[]` | no |
149+
| <a name="input_stage"></a> [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |
150+
| <a name="input_tags"></a> [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br>Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no |
151+
| <a name="input_tenant"></a> [tenant](#input\_tenant) | ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no |
152+
153+
## Outputs
154+
155+
| Name | Description |
156+
|------|-------------|
157+
| <a name="output_application_load_balancer_protections"></a> [application\_load\_balancer\_protections](#output\_application\_load\_balancer\_protections) | AWS Shield Advanced Protections for ALBs |
158+
| <a name="output_cloudfront_distribution_protections"></a> [cloudfront\_distribution\_protections](#output\_cloudfront\_distribution\_protections) | AWS Shield Advanced Protections for CloudFront Distributions |
159+
| <a name="output_elastic_ip_protections"></a> [elastic\_ip\_protections](#output\_elastic\_ip\_protections) | AWS Shield Advanced Protections for Elastic IPs |
160+
| <a name="output_route53_hosted_zone_protections"></a> [route53\_hosted\_zone\_protections](#output\_route53\_hosted\_zone\_protections) | AWS Shield Advanced Protections for Route53 Hosted Zones |
161+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
162+
163+
## References
164+
165+
* [cloudposse/terraform-aws-components](https://github.com/cloudposse/terraform-aws-components/tree/master/modules/aws-shield) - Cloud Posse's upstream component
166+
167+
[<img src="https://cloudposse.com/logo-300x69.svg" height="32" align="right"/>](https://cpco.io/component)

‎modules/aws-shield/alb.tf‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
data "aws_alb" "alb" {
2+
for_each = local.alb_protection_enabled ? toset(var.alb_names) : []
3+
4+
name = each.key
5+
}
6+
7+
resource "aws_shield_protection" "alb_shield_protection" {
8+
for_each = local.alb_protection_enabled ? data.aws_alb.alb : {}
9+
10+
name = data.aws_alb.alb[each.key].name
11+
resource_arn = data.aws_alb.alb[each.key].arn
12+
13+
tags = local.tags
14+
}

‎modules/aws-shield/cloudfront.tf‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
data "aws_cloudfront_distribution" "cloudfront_distribution" {
2+
for_each = local.cloudfront_distribution_protection_enabled ? toset(var.cloudfront_distribution_ids) : []
3+
4+
id = each.key
5+
}
6+
7+
resource "aws_shield_protection" "cloudfront_shield_protection" {
8+
for_each = local.cloudfront_distribution_protection_enabled ? data.aws_cloudfront_distribution.cloudfront_distribution : {}
9+
10+
name = data.aws_cloudfront_distribution.cloudfront_distribution[each.key].domain_name
11+
resource_arn = data.aws_cloudfront_distribution.cloudfront_distribution[each.key].arn
12+
13+
tags = local.tags
14+
}

0 commit comments

Comments
 (0)