aws-wafwebacl-appsync - AWS Solutions Constructs
OverviewPattern Construct PropsPattern PropertiesDefault settingsArchitectureGithub

aws-wafwebacl-appsync

Stability:Stable

Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/
Language Package

Python Logo Python

aws_solutions_constructs.aws_wafwebacl_appsync

Typescript Logo Typescript

@aws-solutions-constructs/aws-wafwebacl-appsync

Java Logo 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:

Example
Typescript
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
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
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

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

Optional - existing instance of a WAF web ACL, providing both this and webaclProps causes an error.

webaclProps?

waf.CfnWebACLProps

Optional user-provided props to override the default props for the AWS WAF web ACL. Providing both this and existingWebaclObj causes an error. 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.

appsyncApi

appsync.CfnGraphQLApi

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.

    • 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

Diagram showing the WAF ACL, AppSync api, CloudWatch log group and IAM role created by the construct

Github

Go to the Github repo for this pattern to view the code, read/create issues and pull requests and more.