Skip to content

cloudposse-terraform-components/aws-shield

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

46 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Project Banner

Latest ReleaseSlack CommunityGet Support

This component is responsible for enabling AWS Shield Advanced Protection for the following resources:

  • Application Load Balancers (ALBs)
  • CloudFront Distributions
  • Elastic IPs (NAT Gateways, EC2 instances)
  • Route53 Hosted Zones

About AWS Shield

AWS Shield is a managed DDoS (Distributed Denial of Service) protection service that safeguards applications running on AWS.

AWS Shield has two tiers:

Feature Shield Standard Shield Advanced
Cost Free (included with AWS) $3,000/month per organization
Protection Layer 3/4 (network/transport) Layer 3/4/7 (includes application layer)
Resources All AWS resources Specific protected resources
DRT Access No Yes (24/7 DDoS Response Team)
Cost Protection No Yes (credits for DDoS-related scaling)
Advanced Metrics No Yes (CloudWatch metrics)
WAF Integration Basic Advanced (custom rules during attacks)

This component configures AWS Shield Advanced protection for specific resources.

Prerequisites

This component requires that the account where it is being provisioned has been subscribed to AWS Shield Advanced.

Important: The Shield Advanced subscription is a manual step that must be completed before deploying this component:

# Subscribe via AWS CLI
aws shield create-subscription

# Or subscribe via AWS Console:
# AWS Shield β†’ Getting started β†’ Subscribe to Shield Advanced

This component assumes that resources it is configured to protect are not already protected by other components that have their xxx_aws_shield_protection_enabled variable set to true.

Tip

πŸ‘½ Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform
Example of running atmos to manage infrastructure from our Quick Start tutorial.

Usage

Stack Level: Global or Regional

AWS Shield Advanced protects both global and regional resources. Deploy this component to the appropriate stack level based on the resources you want to protect:

Resource Type Stack Level Example Stack
Route53 Hosted Zones Global plat-gbl-prod-shield
CloudFront Distributions Global plat-gbl-prod-shield
Application Load Balancers Regional plat-use1-prod-shield
Elastic IPs Regional plat-use1-prod-shield

Complete Example (All Resources)

The following snippet shows how to use all of this component's features in a stack configuration:

components:
  terraform:
    aws-shield:
      metadata:
        component: aws-shield
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        # Global resources
        route53_zone_names:
          - example.com
          - api.example.com
        cloudfront_distribution_ids:
          - E1ABCDEFG12345
          - E2BCDEFGH23456
        # Regional resources
        alb_protection_enabled: true
        alb_names:
          - k8s-common-2c5f23ff99
          - api-gateway-alb
        eips:
          - 3.214.128.240    # NAT Gateway AZ-a
          - 35.172.208.150   # NAT Gateway AZ-b
          - 35.171.70.50     # Bastion host

Global Stack Configuration

A typical global configuration includes Route53 hosted zones and CloudFront distributions. Global stacks typically don't have a VPC, so alb_names and eips should not be defined:

# stacks/catalog/aws-shield/global.yaml
components:
  terraform:
    aws-shield:
      metadata:
        component: aws-shield
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        route53_zone_names:
          - example.com
          - internal.example.com
        cloudfront_distribution_ids:
          - E1ABCDEFG12345

Regional Stack Configuration

Regional configurations protect ALBs and Elastic IPs. CloudFront distributions should not be defined in regional stacks (they are global resources):

# stacks/catalog/aws-shield/regional.yaml
components:
  terraform:
    aws-shield:
      metadata:
        component: aws-shield
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        # Protect ALBs by name
        alb_protection_enabled: true
        alb_names:
          - k8s-common-2c5f23ff99
        # Protect Elastic IPs (NAT Gateways, EC2 instances)
        eips:
          - 3.214.128.240
          - 35.172.208.150
        # Regional Route53 zones (if any)
        route53_zone_names:
          - us-east-1.example.com

Auto-Discovery from EKS ALB Controller

When alb_protection_enabled is true and alb_names is empty, the component automatically discovers ALB names from the eks/alb-controller-ingress-group component via remote state:

components:
  terraform:
    aws-shield:
      vars:
        enabled: true
        # Enable ALB protection with auto-discovery
        alb_protection_enabled: true
        # alb_names is intentionally empty - will be discovered from EKS ALB controller

Catalog Defaults Pattern

Create a catalog defaults file that can be imported and customized per environment:

# stacks/catalog/aws-shield/defaults.yaml
components:
  terraform:
    aws-shield:
      metadata:
        component: aws-shield
      vars:
        enabled: true
        alb_protection_enabled: false
        alb_names: []
        eips: []
        route53_zone_names: []
        cloudfront_distribution_ids: []

Then import and override in your stack:

# stacks/orgs/acme/platform/prod/us-east-1/shield.yaml
import:
  - catalog/aws-shield/defaults

components:
  terraform:
    aws-shield:
      vars:
        alb_protection_enabled: true
        alb_names:
          - prod-api-alb
        eips:
          - 52.1.2.3

Integration with Other Components

Stack configurations that rely on components with a xxx_aws_shield_protection_enabled variable should set that variable to true and leave the corresponding variable for this component empty, relying on that component's AWS Shield Advanced functionality instead. This simplifies inter-component dependencies and minimizes the need for maintaining the provisioning order during a cold-start.

Finding Resource Identifiers

Use the following AWS CLI commands to find resource identifiers:

# List ALB names
aws elbv2 describe-load-balancers --query 'LoadBalancers[*].LoadBalancerName' --output table

# List Elastic IPs
aws ec2 describe-addresses --query 'Addresses[*].[PublicIp,AllocationId,Tags[?Key==`Name`].Value|[0]]' --output table

# List Route53 hosted zones
aws route53 list-hosted-zones --query 'HostedZones[*].[Name,Id]' --output table

# List CloudFront distributions
aws cloudfront list-distributions --query 'DistributionList.Items[*].[Id,DomainName,Origins.Items[0].DomainName]' --output table

Verifying Protection Status

After deployment, verify resources are protected:

# List all protected resources
aws shield list-protections --query 'Protections[*].[Name,ResourceArn]' --output table

# Describe a specific protection
aws shield describe-protection --resource-arn <resource-arn>

# Check subscription status
aws shield describe-subscription

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Requirements

Name Version
terraform >= 1.0.0
aws >= 4.0

Providers

Name Version
aws >= 4.0

Modules

Name Source Version
alb cloudposse/stack-config/yaml//modules/remote-state 1.8.0
iam_roles ../account-map/modules/iam-roles n/a
this cloudposse/label/null 0.25.0

Resources

Name Type
aws_shield_protection.alb_shield_protection resource
aws_shield_protection.cloudfront_shield_protection resource
aws_shield_protection.eip_shield_protection resource
aws_shield_protection.route53_zone_protection resource
aws_alb.alb data source
aws_caller_identity.current data source
aws_cloudfront_distribution.cloudfront_distribution data source
aws_eip.eip data source
aws_partition.current data source
aws_route53_zone.route53_zone data source

Inputs

Name Description Type Default Required
additional_tag_map Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
map(string) {} no
alb_names list of ALB names which will be protected with AWS Shield Advanced list(string) [] no
alb_protection_enabled Enable ALB protection. By default, ALB names are read from the EKS cluster ALB control group bool false no
attributes ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
list(string) [] no
cloudfront_distribution_ids list of CloudFront Distribution IDs which will be protected with AWS Shield Advanced list(string) [] no
context Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
any
{
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"unset"
],
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
}
no
delimiter Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
string null no
descriptor_formats Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
any {} no
eips List of Elastic IPs which will be protected with AWS Shield Advanced list(string) [] no
enabled Set to false to prevent the module from creating any resources bool null no
environment ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' string null no
id_length_limit Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
number null no
label_key_case Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
string null no
label_order The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
list(string) null no
label_value_case Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
string null no
labels_as_tags Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
set(string)
[
"default"
]
no
name ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
string null no
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
regex_replace_chars Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
string null no
region AWS Region string n/a yes
route53_zone_names List of Route53 Hosted Zone names which will be protected with AWS Shield Advanced list(string) [] no
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null no
tags Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string) {} no
tenant ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for string null no

Outputs

Name Description
application_load_balancer_protections AWS Shield Advanced Protections for ALBs
cloudfront_distribution_protections AWS Shield Advanced Protections for CloudFront Distributions
elastic_ip_protections AWS Shield Advanced Protections for Elastic IPs
route53_hosted_zone_protections AWS Shield Advanced Protections for Route53 Hosted Zones

Related Projects

Check out these related projects.

  • terraform-aws-waf - Terraform module to create and manage AWS WAF rules for additional application-layer protection
  • aws-wafv2 Component - Cloud Posse component for AWS WAFv2, often used alongside Shield Advanced
  • Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
  • Atmos - Atmos is like docker-compose but for your infrastructure

References

For additional context, refer to some of these links.

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

βœ… We build it together with your team.
βœ… Your team owns everything.
βœ… 100% Open Source and backed by fanatical support.

Request Quote

πŸ“š Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

  • Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
  • Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
  • Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
  • Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
  • GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Request Quote

Day-2: Your Operational Mastery

  • Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
  • Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
  • Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
  • Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
  • Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
  • Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
  • Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

Request Quote

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For πŸ› bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Running Terraform Tests

We use Atmos to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.

All tests are located in the test/ folder.

Under the hood, tests are powered by Terratest together with our internal Test Helpers library, providing robust infrastructure validation.

Setup dependencies:

To run tests:

  • Run all tests:
    atmos test run
  • Clean up test artifacts:
    atmos test clean
  • Explore additional test options:
    atmos test --help

The configuration for test commands is centrally managed. To review what's being imported, see the atmos.yaml file.

Learn more about our automated testing in our documentation or implementing custom commands with atmos.

🌎 Slack Community

Join our Open Source Community 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.

πŸ“° Newsletter

Sign up for our 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. Dropped straight into your Inbox every week β€” and usually a 5-minute read.

πŸ“† Office Hours

Join us every Wednesday via Zoom 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. It's FREE for everyone!

License

License

Preamble to the Apache License, Version 2.0

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.


Copyright Β© 2017-2026 Cloud Posse, LLC

README footer

Beacon

About

This component is responsible for enabling AWS Shield Advanced Protection for the following resources: Application Load Balancers (ALBs), CloudFront Distributions, Elastic IPs, Route53 Hosted Zones

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

 
 
 

Contributors