# aws-wafwebacl-alb module
<!--BEGIN STABILITY BANNER-->---
> 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](https://semver.org/) 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.
---
<!--END STABILITY BANNER-->
| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
|:-------------|:-------------|
<div style="height:8px"></div>
| **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:
Typescript
```python
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
```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
```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`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer.html)|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`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_waf.CfnWebACL.html)|Existing instance of a WAF web ACL, an error will occur if this and props is set.|
|webaclProps?|[`waf.CfnWebACLProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_waf.CfnWebACLProps.html)|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)`](../core/lib/waf-defaults.ts) function from core to create an array entry from each desired managed rule set.|
## Pattern Properties
| **Name** | **Type** | **Description** |
|:-------------|:----------------|-----------------|
|webacl|[`waf.CfnWebACL`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_waf.CfnWebACL.html)|Returns an instance of the waf.CfnWebACL created by the construct.|
|loadBalancer|[`elbv2.ApplicationLoadBalancer`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer.html)|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](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list.html).
* 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 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Raw data
{
"_id": null,
"home_page": "https://github.com/awslabs/aws-solutions-constructs.git",
"name": "aws-solutions-constructs.aws-wafwebacl-alb",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Amazon Web Services",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/07/21/c2a8224e580fb4cfc317cc9feef836d2be802bb60665d7f13ff64e7324a2/aws_solutions_constructs_aws_wafwebacl_alb-2.74.0.tar.gz",
"platform": null,
"description": "# aws-wafwebacl-alb module\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n\n\n> All classes are under active development and subject to non-backward compatible changes or removal in any\n> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.\n> 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.\n\n---\n<!--END STABILITY BANNER-->\n\n| **Reference Documentation**:| <span style=\"font-weight: normal\">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|\n|:-------------|:-------------|\n\n<div style=\"height:8px\"></div>\n\n| **Language** | **Package** |\n|:-------------|-----------------|\n| Python|`aws_solutions_constructs.aws_wafwebacl_alb`|\n| Typescript|`@aws-solutions-constructs/aws-wafwebacl-alb`|\n| Java|`software.amazon.awsconstructs.services.wafwebaclalb`|\n\n## Overview\n\nThis AWS Solutions Construct implements an AWS WAF web ACL connected to an Application Load Balancer.\n\nHere is a minimal deployable pattern definition:\n\nTypescript\n\n```python\nimport { Construct } from 'constructs';\nimport { Stack, StackProps } from 'aws-cdk-lib';\nimport { WafwebaclToAlbProps, WafwebaclToAlb } from \"@aws-solutions-constructs/aws-wafwebacl-alb\";\n\n// Use an existing ALB, such as one created by Route53toAlb or AlbToLambda\nconst existingLoadBalancer = previouslyCreatedLoadBalancer\n\n\n// Note - all alb constructs turn on ELB logging by default, so require that an environment including account\n// and region be provided when creating the stack\n//\n// new MyStack(app, 'id', {env: {account: '123456789012', region: 'us-east-1' }});\n//\n// This construct can only be attached to a configured Application Load Balancer.\nnew WafwebaclToAlb(this, 'test-wafwebacl-alb', {\n existingLoadBalancerObj: existingLoadBalancer\n});\n```\n\nPython\n\n```python\nfrom aws_solutions_constructs.aws_route53_alb import Route53ToAlb\nfrom aws_solutions_constructs.aws_wafwebacl_alb import WafwebaclToAlbProps, WafwebaclToAlb\nfrom aws_cdk import (\n aws_route53 as route53,\n Stack\n)\nfrom constructs import Construct\n\n# Use an existing ALB, such as one created by Route53toAlb or AlbToLambda\nexistingLoadBalancer = previouslyCreatedLoadBalancer\n\n# Note - all alb constructs turn on ELB logging by default, so require that an environment including account\n# and region be provided when creating the stack\n#\n# MyStack(app, 'id', env=cdk.Environment(account='123456789012', region='us-east-1'))\n#\n# This construct can only be attached to a configured Application Load Balancer.\nWafwebaclToAlb(self, 'test_wafwebacl_alb',\n existing_load_balancer_obj=existingLoadBalancer\n )\n```\n\nJava\n\n```java\nimport software.constructs.Construct;\n\nimport software.amazon.awscdk.Stack;\nimport software.amazon.awscdk.StackProps;\nimport software.amazon.awscdk.services.route53.*;\nimport software.amazon.awsconstructs.services.wafwebaclalb.*;\n\n// Use an existing ALB, such as one created by Route53toAlb or AlbToLambda\nfinal existingLoadBalancer = previouslyCreatedLoadBalancer\n\n// Note - all alb constructs turn on ELB logging by default, so require that an environment including account\n// and region be provided when creating the stack\n//\n// new MyStack(app, \"id\", StackProps.builder()\n// .env(Environment.builder()\n// .account(\"123456789012\")\n// .region(\"us-east-1\")\n// .build());\n//\n// This construct can only be attached to a configured Application Load Balancer.\nnew WafwebaclToAlb(this, \"test-wafwebacl-alb\", new WafwebaclToAlbProps.Builder()\n .existingLoadBalancerObj(existingLoadBalancer)\n .build());\n```\n\n## Pattern Construct Props\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|existingLoadBalancerObj|[`elbv2.ApplicationLoadBalancer`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer.html)|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.*|\n|existingWebaclObj?|[`waf.CfnWebACL`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_waf.CfnWebACL.html)|Existing instance of a WAF web ACL, an error will occur if this and props is set.|\n|webaclProps?|[`waf.CfnWebACLProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_waf.CfnWebACLProps.html)|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)`](../core/lib/waf-defaults.ts) function from core to create an array entry from each desired managed rule set.|\n\n## Pattern Properties\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|webacl|[`waf.CfnWebACL`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_waf.CfnWebACL.html)|Returns an instance of the waf.CfnWebACL created by the construct.|\n|loadBalancer|[`elbv2.ApplicationLoadBalancer`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer.html)|Returns an instance of the Application Load Balancer Object created by the pattern. |\n\n## Default settings\n\nOut of the box implementation of the Construct without any override will set the following defaults:\n\n### AWS WAF\n\n* Deploy a WAF web ACL with 7 [AWS managed rule groups](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list.html).\n\n * AWSManagedRulesBotControlRuleSet\n * AWSManagedRulesKnownBadInputsRuleSet\n * AWSManagedRulesCommonRuleSet\n * AWSManagedRulesAnonymousIpList\n * AWSManagedRulesAmazonIpReputationList\n * AWSManagedRulesAdminProtectionRuleSet\n * AWSManagedRulesSQLiRuleSet\n\n *Note that the default rules can be replaced by specifying the rules property of CfnWebACLProps*\n* Send metrics to Amazon CloudWatch\n\n### Application Load Balancer\n\n* User provided Application Load Balancer object is used as-is\n\n## Architecture\n\n\n\n---\n\n\n\u00a9 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "CDK constructs for defining an AWS web WAF connected to an Application Load Balancer.",
"version": "2.74.0",
"project_urls": {
"Homepage": "https://github.com/awslabs/aws-solutions-constructs.git",
"Source": "https://github.com/awslabs/aws-solutions-constructs.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6abe5c2a1494ae3b149068373cf03e648371f4570410645fb29a32c54ffb5013",
"md5": "3fcc1898cd42bca1a7d9abdbe5629818",
"sha256": "322dcfd6b2577521c83a07ffbae7ec4ed5dd95c7bd3f62cb0c908b7ebb06f04f"
},
"downloads": -1,
"filename": "aws_solutions_constructs.aws_wafwebacl_alb-2.74.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3fcc1898cd42bca1a7d9abdbe5629818",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 186818,
"upload_time": "2024-10-22T18:08:51",
"upload_time_iso_8601": "2024-10-22T18:08:51.482099Z",
"url": "https://files.pythonhosted.org/packages/6a/be/5c2a1494ae3b149068373cf03e648371f4570410645fb29a32c54ffb5013/aws_solutions_constructs.aws_wafwebacl_alb-2.74.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0721c2a8224e580fb4cfc317cc9feef836d2be802bb60665d7f13ff64e7324a2",
"md5": "65f36f41e42363a5a0f7f6a31396bea1",
"sha256": "62b47aca67a1f357f3685b1a3d81b5df9319c08dd0a529ed56fa1df2835d615a"
},
"downloads": -1,
"filename": "aws_solutions_constructs_aws_wafwebacl_alb-2.74.0.tar.gz",
"has_sig": false,
"md5_digest": "65f36f41e42363a5a0f7f6a31396bea1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 187899,
"upload_time": "2024-10-22T18:10:11",
"upload_time_iso_8601": "2024-10-22T18:10:11.898829Z",
"url": "https://files.pythonhosted.org/packages/07/21/c2a8224e580fb4cfc317cc9feef836d2be802bb60665d7f13ff64e7324a2/aws_solutions_constructs_aws_wafwebacl_alb-2.74.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 18:10:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "awslabs",
"github_project": "aws-solutions-constructs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aws-solutions-constructs.aws-wafwebacl-alb"
}
JSON
