# aws-wafwebacl-appsync 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_appsync` |
|  Typescript | `@aws-solutions-constructs/aws-wafwebacl-appsync` |
|  Java | `software.amazon.awsconstructs.services.wafwebaclappsync` |
## Overview
This AWS Solutions Construct implements an AWS WAF web ACL connected to an AWS AppSync API.
Here is a minimal deployable pattern definition:
Typescript
```python
import { Construct } from "constructs";
import { Stack, StackProps } from "aws-cdk-lib";
import {
WafwebaclToAppsyncProps,
WafwebaclToAppsync,
} from "@aws-solutions-constructs/aws-wafwebacl-appsync";
// Use an existing AppSync GraphQL API
const existingGraphQLApi = previouslyCreatedApi;
// This construct can only be attached to a configured AWS AppSync API.
new WafwebaclToAppsync(this, "test-wafwebacl-appsync", {
existingAppsyncApi: existingGraphQLApi,
});
```
Python
```python
from aws_solutions_constructs.aws_wafwebacl_appsync import WafwebaclToAppsyncProps, WafwebaclToAppsync
from aws_cdk import (
aws_route53 as route53,
Stack
)
from constructs import Construct
# Use an existing AppSync API
existingGraphQLApi = previouslyCreatedApi
# This construct can only be attached to a configured AWS AppSync API.
WafwebaclToAppsync(self, 'test_wafwebacl_appsync',
existing_appsync_api=existingGraphQLApi
)
```
Java
```java
import software.constructs.Construct;
import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awsconstructs.services.wafwebaclappsync.*;
// Use an existing AppSync API
final existingGraphQLApi = previouslyCreatedApi
// This construct can only be attached to a configured AWS AppSync API.
new WafwebaclToAppsync(this, "test-wafwebacl-appsync", new WafwebaclToAppsyncProps.Builder()
.existingAppsyncApi(existingGraphQLApi)
.build());
```
## Pattern Construct Props
| **Name** | **Type** | **Description** |
| :----------------- | :---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| existingAppsyncApi | [`appsync.CfnGraphQLApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appsync.CfnGraphQLApi.html) | The existing Appsync CfnGraphQLApi object that will be protected with the WAF web ACL. *Note that a WAF web ACL can only be added to a configured AppSync API, so this construct only accepts an existing CfnGraphQLApi and does not accept CfnGraphQLApiProps.* |
| 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. |
| appsyncApi | [`appsync.CfnGraphQLApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appsync.CfnGraphQLApi.html) | Returns an instance of the CfnGraphQLApi used 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
### AppSync API
* User provided AppSync graphql API 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-appsync",
"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/33/bb/3986333ab59d025761178d92919a5d2e93860f1b6280b822cc12c51a8b53/aws_solutions_constructs_aws_wafwebacl_appsync-2.74.0.tar.gz",
"platform": null,
"description": "# aws-wafwebacl-appsync 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_appsync` |\n|  Typescript | `@aws-solutions-constructs/aws-wafwebacl-appsync` |\n|  Java | `software.amazon.awsconstructs.services.wafwebaclappsync` |\n\n## Overview\n\nThis AWS Solutions Construct implements an AWS WAF web ACL connected to an AWS AppSync API.\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 {\n WafwebaclToAppsyncProps,\n WafwebaclToAppsync,\n} from \"@aws-solutions-constructs/aws-wafwebacl-appsync\";\n\n// Use an existing AppSync GraphQL API\nconst existingGraphQLApi = previouslyCreatedApi;\n\n// This construct can only be attached to a configured AWS AppSync API.\nnew WafwebaclToAppsync(this, \"test-wafwebacl-appsync\", {\n existingAppsyncApi: existingGraphQLApi,\n});\n```\n\nPython\n\n```python\nfrom aws_solutions_constructs.aws_wafwebacl_appsync import WafwebaclToAppsyncProps, WafwebaclToAppsync\nfrom aws_cdk import (\n aws_route53 as route53,\n Stack\n)\nfrom constructs import Construct\n\n# Use an existing AppSync API\nexistingGraphQLApi = previouslyCreatedApi\n\n\n# This construct can only be attached to a configured AWS AppSync API.\nWafwebaclToAppsync(self, 'test_wafwebacl_appsync',\n existing_appsync_api=existingGraphQLApi\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.awsconstructs.services.wafwebaclappsync.*;\n\n// Use an existing AppSync API\nfinal existingGraphQLApi = previouslyCreatedApi\n\n\n// This construct can only be attached to a configured AWS AppSync API.\nnew WafwebaclToAppsync(this, \"test-wafwebacl-appsync\", new WafwebaclToAppsyncProps.Builder()\n .existingAppsyncApi(existingGraphQLApi)\n .build());\n```\n\n## Pattern Construct Props\n\n| **Name** | **Type** | **Description** |\n| :----------------- | :---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| existingAppsyncApi | [`appsync.CfnGraphQLApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appsync.CfnGraphQLApi.html) | The existing Appsync CfnGraphQLApi object that will be protected with the WAF web ACL. *Note that a WAF web ACL can only be added to a configured AppSync API, so this construct only accepts an existing CfnGraphQLApi and does not accept CfnGraphQLApiProps.* |\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| appsyncApi | [`appsync.CfnGraphQLApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appsync.CfnGraphQLApi.html) | Returns an instance of the CfnGraphQLApi used 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### AppSync API\n\n* User provided AppSync graphql API 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 AWS AppSync API.",
"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": "7d50abfbbf7e366d5d1ce758cd25848fa25712c71af0d65f8e8c754150cfac19",
"md5": "7ff0126833e78a06c0f1bd5119392325",
"sha256": "9489218047f22eadeb29ab0057e18a6115cd6ace52cb2eb1d7f12598becfe1d8"
},
"downloads": -1,
"filename": "aws_solutions_constructs.aws_wafwebacl_appsync-2.74.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7ff0126833e78a06c0f1bd5119392325",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 154718,
"upload_time": "2024-10-22T18:08:54",
"upload_time_iso_8601": "2024-10-22T18:08:54.204933Z",
"url": "https://files.pythonhosted.org/packages/7d/50/abfbbf7e366d5d1ce758cd25848fa25712c71af0d65f8e8c754150cfac19/aws_solutions_constructs.aws_wafwebacl_appsync-2.74.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "33bb3986333ab59d025761178d92919a5d2e93860f1b6280b822cc12c51a8b53",
"md5": "741b59b62cd0c287f245fe92fbf38752",
"sha256": "7579b8b48e727e781e78208eac4f82dbe0c39fb5c82ec1dea682ca3988ae7d92"
},
"downloads": -1,
"filename": "aws_solutions_constructs_aws_wafwebacl_appsync-2.74.0.tar.gz",
"has_sig": false,
"md5_digest": "741b59b62cd0c287f245fe92fbf38752",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 155440,
"upload_time": "2024-10-22T18:10:14",
"upload_time_iso_8601": "2024-10-22T18:10:14.315241Z",
"url": "https://files.pythonhosted.org/packages/33/bb/3986333ab59d025761178d92919a5d2e93860f1b6280b822cc12c51a8b53/aws_solutions_constructs_aws_wafwebacl_appsync-2.74.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 18:10:14",
"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-appsync"
}
JSON
