aws-wafwebacl-alb module
All classes are under active development and subject to non-backward compatible changes or removal in any
future version. These are not subject to the Semantic Versioning model.
This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
Language |
Package |
Python |
aws_solutions_constructs.aws_wafwebacl_alb |
Typescript |
@aws-solutions-constructs/aws-wafwebacl-alb |
Java |
software.amazon.awsconstructs.services.wafwebaclalb |
Overview
This AWS Solutions Construct implements an AWS WAF web ACL connected to an Application Load Balancer.
Here is a minimal deployable pattern definition in Typescript:
import { Route53ToAlb } from '@aws-solutions-constructs/aws-route53-alb';
import { WafwebaclToAlbProps, WafwebaclToAlb } from "@aws-solutions-constructs/aws-wafwebacl-alb";
// A constructed ALB is required to be attached to the WAF Web ACL.
// In this case, we are using this construct to create one.
const r53ToAlb = new Route53ToAlb(this, 'Route53ToAlbPattern', {
privateHostedZoneProps: {
zoneName: 'www.example.com',
},
publicApi: false,
logAccessLogs: false
});
// This construct can only be attached to a configured Application Load Balancer.
new WafwebaclToAlb(this, 'test-wafwebacl-alb', {
existingLoadBalancerObj: r53ToAlb.loadBalancer
});
Initializer
new WafwebaclToAlb(scope: Construct, id: string, props: WafwebaclToAlbProps);
Parameters
Pattern Construct Props
Name |
Type |
Description |
existingLoadBalancerObj |
elbv2.ApplicationLoadBalancer |
The existing Application Load Balancer Object that will be protected with the WAF web ACL. Note that a WAF web ACL can only be added to a configured Application Load Balancer, so this construct only accepts an existing ApplicationLoadBalancer and does not accept applicationLoadBalancerProps. |
existingWebaclObj? |
waf.CfnWebACL |
Existing instance of a WAF web ACL, an error will occur if this and props is set. |
webaclProps? |
waf.CfnWebACLProps |
Optional user-provided props to override the default props for the AWS WAF web ACL. To use a different collection of managed rule sets, specify a new rules property. Use our wrapManagedRuleSet(managedGroupName: string, vendorName: string, priority: number) function from core to create an array entry from each desired managed rule set. |
Pattern Properties
Name |
Type |
Description |
webacl |
waf.CfnWebACL |
Returns an instance of the waf.CfnWebACL created by the construct. |
loadBalancer |
elbv2.ApplicationLoadBalancer |
Returns an instance of the Application Load Balancer Object created by the pattern. |
Default settings
Out of the box implementation of the Construct without any override will set the following defaults:
AWS WAF
-
Deploy a WAF web ACL with 7 AWS managed rule groups.
- AWSManagedRulesBotControlRuleSet
- AWSManagedRulesKnownBadInputsRuleSet
- AWSManagedRulesCommonRuleSet
- AWSManagedRulesAnonymousIpList
- AWSManagedRulesAmazonIpReputationList
- AWSManagedRulesAdminProtectionRuleSet
- AWSManagedRulesSQLiRuleSet
Note that the default rules can be replaced by specifying the rules property of CfnWebACLProps
-
Send metrics to Amazon CloudWatch
Application Load Balancer
- User provided Application Load Balancer object is used as-is
Architecture
© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.