Skip to main content

CDK constructs for defining an AWS web WAF connected to an Application Load Balancer.

Project description

aws-wafwebacl-alb module

---

Stability: Experimental

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.


Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/
Language Package
Python Logo Python aws_solutions_constructs.aws_wafwebacl_alb
Typescript Logo Typescript @aws-solutions-constructs/aws-wafwebacl-alb
Java Logo 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:

Typescript

import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { WafwebaclToAlbProps, WafwebaclToAlb } from "@aws-solutions-constructs/aws-wafwebacl-alb";

// Use an existing ALB, such as one created by Route53toAlb or AlbToLambda
const existingLoadBalancer = previouslyCreatedLoadBalancer


// Note - all alb constructs turn on ELB logging by default, so require that an environment including account
// and region be provided when creating the stack
//
// new MyStack(app, 'id', {env: {account: '123456789012', region: 'us-east-1' }});
//
// This construct can only be attached to a configured Application Load Balancer.
new WafwebaclToAlb(this, 'test-wafwebacl-alb', {
    existingLoadBalancerObj: existingLoadBalancer
});

Python

from aws_solutions_constructs.aws_route53_alb import Route53ToAlb
from aws_solutions_constructs.aws_wafwebacl_alb import WafwebaclToAlbProps, WafwebaclToAlb
from aws_cdk import (
    aws_route53 as route53,
    Stack
)
from constructs import Construct

# Use an existing ALB, such as one created by Route53toAlb or AlbToLambda
existingLoadBalancer = previouslyCreatedLoadBalancer

# Note - all alb constructs turn on ELB logging by default, so require that an environment including account
# and region be provided when creating the stack
#
# MyStack(app, 'id', env=cdk.Environment(account='123456789012', region='us-east-1'))
#
# This construct can only be attached to a configured Application Load Balancer.
WafwebaclToAlb(self, 'test_wafwebacl_alb',
                existing_load_balancer_obj=existingLoadBalancer
                )

Java

import software.constructs.Construct;

import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.services.route53.*;
import software.amazon.awsconstructs.services.wafwebaclalb.*;

// Use an existing ALB, such as one created by Route53toAlb or AlbToLambda
final existingLoadBalancer = previouslyCreatedLoadBalancer

// Note - all alb constructs turn on ELB logging by default, so require that an environment including account
// and region be provided when creating the stack
//
// new MyStack(app, "id", StackProps.builder()
//         .env(Environment.builder()
//                 .account("123456789012")
//                 .region("us-east-1")
//                 .build());
//
// This construct can only be attached to a configured Application Load Balancer.
new WafwebaclToAlb(this, "test-wafwebacl-alb", new WafwebaclToAlbProps.Builder()
        .existingLoadBalancerObj(existingLoadBalancer)
        .build());

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

Architecture Diagram


© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file aws_solutions_constructs_aws_wafwebacl_alb-2.70.0.tar.gz.

File metadata

File hashes

Hashes for aws_solutions_constructs_aws_wafwebacl_alb-2.70.0.tar.gz
Algorithm Hash digest
SHA256 d7eb9b3fb3c97804a73d249d8ede30a97d3616a97c403af7c677bab0159e36bb
MD5 538cd622714096aeb9fdf91acebbc0fe
BLAKE2b-256 bd61aa83cc8e40af19e7a28c64b35315af2224a1f397d90739523c65051a080e

See more details on using hashes here.

File details

Details for the file aws_solutions_constructs.aws_wafwebacl_alb-2.70.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_solutions_constructs.aws_wafwebacl_alb-2.70.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cd33e35c92c11efb96327429fefdb892a48529f06b3a315c2294661c577b889e
MD5 d8fb22e4754693344c73614cb834fbb9
BLAKE2b-256 4f597f7db534ee330dddde2902d8c8d1ee003e8d0acb2b3155263a95c7d3f2f6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page