Skip to main content

Component: aws-shield

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

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.

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

Usage

Stack Level: Global or Regional

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

components:
terraform:
aws-shield:
settings:
spacelift:
workspace_enabled: true
vars:
enabled: true
route53_zone_names:
- test.ue1.example.net
alb_names:
- k8s-common-2c5f23ff99
cloudfront_distribution_ids:
- EDFDVBD632BHDS5
eips:
- 3.214.128.240
- 35.172.208.150
- 35.171.70.50

A typical global configuration will only include the route53_zone_names and cloudfront_distribution_ids variables, as global Route53 Hosted Zones may exist in that account, and because CloudFront is a global AWS service.

A global stack configuration will not have a VPC, and hence alb_names and eips should not be defined:

components:
terraform:
aws-shield:
settings:
spacelift:
workspace_enabled: true
vars:
enabled: true
route53_zone_names:
- test.example.net
cloudfront_distribution_ids:
- EDFDVBD632BHDS5

Regional stack configurations will typically make use of all resources except for cloudfront_distribution_ids:

components:
terraform:
aws-shield:
settings:
spacelift:
workspace_enabled: true
vars:
route53_zone_names:
- test.ue1.example.net
alb_names:
- k8s-common-2c5f23ff99
eips:
- 3.214.128.240
- 35.172.208.150
- 35.171.70.50

Stack configurations which 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 as empty, relying on that component's AWS Shield Advanced functionality instead. This leads to more simplified inter-component dependencies and minimizes the need for maintaining the provisioning order during a cold-start.

Requirements

NameVersion
terraform>= 1.0.0
aws>= 4.0

Providers

NameVersion
aws>= 4.0

Modules

NameSourceVersion
albcloudposse/stack-config/yaml//modules/remote-state1.5.0
iam_roles../account-map/modules/iam-rolesn/a
thiscloudposse/label/null0.25.0

Resources

NameType
aws_shield_protection.alb_shield_protectionresource
aws_shield_protection.cloudfront_shield_protectionresource
aws_shield_protection.eip_shield_protectionresource
aws_shield_protection.route53_zone_protectionresource
aws_alb.albdata source
aws_caller_identity.currentdata source
aws_cloudfront_distribution.cloudfront_distributiondata source
aws_eip.eipdata source
aws_partition.currentdata source
aws_route53_zone.route53_zonedata source

Inputs

NameDescriptionTypeDefaultRequired
additional_tag_mapAdditional 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_nameslist of ALB names which will be protected with AWS Shield Advancedlist(string)[]no
alb_protection_enabledEnable ALB protection. By default, ALB names are read from the EKS cluster ALB control groupboolfalseno
attributesID 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_idslist of CloudFront Distribution IDs which will be protected with AWS Shield Advancedlist(string)[]no
contextSingle 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
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
stringnullno
descriptor_formatsDescribe 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
eipsList of Elastic IPs which will be protected with AWS Shield Advancedlist(string)[]no
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
id_length_limitLimit 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.
numbernullno
label_key_caseControls 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.
stringnullno
label_orderThe 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)nullno
label_value_caseControls 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.
stringnullno
labels_as_tagsSet 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
nameID 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.
stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform 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.
stringnullno
regionAWS Regionstringn/ayes
route53_zone_namesList of Route53 Hosted Zone names which will be protected with AWS Shield Advancedlist(string)[]no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno

Outputs

NameDescription
application_load_balancer_protectionsAWS Shield Advanced Protections for ALBs
cloudfront_distribution_protectionsAWS Shield Advanced Protections for CloudFront Distributions
elastic_ip_protectionsAWS Shield Advanced Protections for Elastic IPs
route53_hosted_zone_protectionsAWS Shield Advanced Protections for Route53 Hosted Zones

References