Skip to content

Commit e11d2f9

Browse files
author
awstools
committed
feat(client-wafv2): For web ACLs that protect CloudFront protections, the default request body inspection size is now 16 KB, and you can use the new association configuration to increase the inspection size further, up to 64 KB. Sizes over 16 KB can incur additional costs.
1 parent 11ea352 commit e11d2f9

14 files changed

+744
-879
lines changed

clients/client-wafv2/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Guide</a>.</p>
3939
<ul>
4040
<li>
4141
<p>For regional applications, you can use any of the endpoints in the list.
42-
A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner service. </p>
42+
A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
4343
</li>
4444
<li>
4545
<p>For Amazon CloudFront applications, you must use the API endpoint listed for

clients/client-wafv2/src/WAFV2.ts

+13-11
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ import { WAFV2Client } from "./WAFV2Client";
242242
* <ul>
243243
* <li>
244244
* <p>For regional applications, you can use any of the endpoints in the list.
245-
* A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner service. </p>
245+
* A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
246246
* </li>
247247
* <li>
248248
* <p>For Amazon CloudFront applications, you must use the API endpoint listed for
@@ -276,10 +276,10 @@ export class WAFV2 extends WAFV2Client {
276276
/**
277277
* @public
278278
* <p>Associates a web ACL with a regional application resource, to protect the resource.
279-
* A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner service. </p>
279+
* A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
280280
* <p>For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To
281281
* associate a web ACL, in the CloudFront call <code>UpdateDistribution</code>, set the web ACL ID
282-
* to the Amazon Resource Name (ARN) of the web ACL. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>.</p>
282+
* to the Amazon Resource Name (ARN) of the web ACL. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>
283283
* <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
284284
*/
285285
public associateWebACL(
@@ -323,8 +323,8 @@ export class WAFV2 extends WAFV2Client {
323323
* Simple rules that cost little to run use fewer WCUs than more complex rules
324324
* that use more processing power.
325325
* Rule group capacity is fixed at creation, which helps users plan their
326-
* web ACL WCU usage when they use a rule group.
327-
* The WCU limit for web ACLs is 1,500. </p>
326+
* web ACL WCU usage when they use a rule group. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html">WAF web ACL capacity units (WCU)</a>
327+
* in the <i>WAF Developer Guide</i>. </p>
328328
*/
329329
public checkCapacity(
330330
args: CheckCapacityCommandInput,
@@ -456,7 +456,7 @@ export class WAFV2 extends WAFV2Client {
456456
/**
457457
* @public
458458
* <p>Creates a <a>WebACL</a> per the specifications provided.</p>
459-
* <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, Amazon Cognito user pool, or an App Runner service. </p>
459+
* <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
460460
*/
461461
public createWebACL(
462462
args: CreateWebACLCommandInput,
@@ -696,7 +696,8 @@ export class WAFV2 extends WAFV2Client {
696696
* </li>
697697
* <li>
698698
* <p>For Amazon CloudFront distributions, use the CloudFront call
699-
* <code>ListDistributionsByWebACLId</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html">ListDistributionsByWebACLId</a>.</p>
699+
* <code>ListDistributionsByWebACLId</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html">ListDistributionsByWebACLId</a>
700+
* in the <i>Amazon CloudFront API Reference</i>. </p>
700701
* </li>
701702
* </ul>
702703
* </li>
@@ -708,7 +709,8 @@ export class WAFV2 extends WAFV2Client {
708709
* </li>
709710
* <li>
710711
* <p>For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call
711-
* <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>.</p>
712+
* <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>
713+
* in the <i>Amazon CloudFront API Reference</i>. </p>
712714
* </li>
713715
* </ul>
714716
* </li>
@@ -778,10 +780,10 @@ export class WAFV2 extends WAFV2Client {
778780
/**
779781
* @public
780782
* <p>Disassociates the specified regional application resource from any existing web ACL
781-
* association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner service. </p>
783+
* association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
782784
* <p>For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To
783785
* disassociate a web ACL, provide an empty web ACL ID in the CloudFront call
784-
* <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>.</p>
786+
* <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a> in the <i>Amazon CloudFront API Reference</i>. </p>
785787
*/
786788
public disassociateWebACL(
787789
args: DisassociateWebACLCommandInput,
@@ -2045,7 +2047,7 @@ export class WAFV2 extends WAFV2Client {
20452047
* </ol>
20462048
* </note>
20472049
* <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
2048-
* <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, Amazon Cognito user pool, or an App Runner service. </p>
2050+
* <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
20492051
*/
20502052
public updateWebACL(
20512053
args: UpdateWebACLCommandInput,

clients/client-wafv2/src/WAFV2Client.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,7 @@ export interface WAFV2ClientResolvedConfig extends WAFV2ClientResolvedConfigType
479479
* <ul>
480480
* <li>
481481
* <p>For regional applications, you can use any of the endpoints in the list.
482-
* A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner service. </p>
482+
* A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
483483
* </li>
484484
* <li>
485485
* <p>For Amazon CloudFront applications, you must use the API endpoint listed for

clients/client-wafv2/src/commands/AssociateWebACLCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ export interface AssociateWebACLCommandOutput extends AssociateWebACLResponse, _
3636
/**
3737
* @public
3838
* <p>Associates a web ACL with a regional application resource, to protect the resource.
39-
* A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, a Amazon Cognito user pool, or an App Runner service. </p>
39+
* A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
4040
* <p>For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To
4141
* associate a web ACL, in the CloudFront call <code>UpdateDistribution</code>, set the web ACL ID
42-
* to the Amazon Resource Name (ARN) of the web ACL. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>.</p>
42+
* to the Amazon Resource Name (ARN) of the web ACL. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>
4343
* <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
4444
* @example
4545
* Use a bare-bones client and the command you need to make an API call.

clients/client-wafv2/src/commands/CheckCapacityCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ export interface CheckCapacityCommandOutput extends CheckCapacityResponse, __Met
4545
* Simple rules that cost little to run use fewer WCUs than more complex rules
4646
* that use more processing power.
4747
* Rule group capacity is fixed at creation, which helps users plan their
48-
* web ACL WCU usage when they use a rule group.
49-
* The WCU limit for web ACLs is 1,500. </p>
48+
* web ACL WCU usage when they use a rule group. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html">WAF web ACL capacity units (WCU)</a>
49+
* in the <i>WAF Developer Guide</i>. </p>
5050
* @example
5151
* Use a bare-bones client and the command you need to make an API call.
5252
* ```javascript

clients/client-wafv2/src/commands/CreateWebACLCommand.ts

+8-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface CreateWebACLCommandOutput extends CreateWebACLResponse, __Metad
3636
/**
3737
* @public
3838
* <p>Creates a <a>WebACL</a> per the specifications provided.</p>
39-
* <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, Amazon Cognito user pool, or an App Runner service. </p>
39+
* <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
4040
* @example
4141
* Use a bare-bones client and the command you need to make an API call.
4242
* ```javascript
@@ -802,6 +802,13 @@ export interface CreateWebACLCommandOutput extends CreateWebACLResponse, __Metad
802802
* TokenDomains: [ // TokenDomains
803803
* "STRING_VALUE",
804804
* ],
805+
* AssociationConfig: { // AssociationConfig
806+
* RequestBody: { // RequestBody
807+
* "<keys>": { // RequestBodyAssociatedResourceTypeConfig
808+
* DefaultSizeInspectionLimit: "KB_16" || "KB_32" || "KB_48" || "KB_64", // required
809+
* },
810+
* },
811+
* },
805812
* };
806813
* const command = new CreateWebACLCommand(input);
807814
* const response = await client.send(command);

clients/client-wafv2/src/commands/DeleteWebACLCommand.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ export interface DeleteWebACLCommandOutput extends DeleteWebACLResponse, __Metad
5050
* </li>
5151
* <li>
5252
* <p>For Amazon CloudFront distributions, use the CloudFront call
53-
* <code>ListDistributionsByWebACLId</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html">ListDistributionsByWebACLId</a>.</p>
53+
* <code>ListDistributionsByWebACLId</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html">ListDistributionsByWebACLId</a>
54+
* in the <i>Amazon CloudFront API Reference</i>. </p>
5455
* </li>
5556
* </ul>
5657
* </li>
@@ -62,7 +63,8 @@ export interface DeleteWebACLCommandOutput extends DeleteWebACLResponse, __Metad
6263
* </li>
6364
* <li>
6465
* <p>For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call
65-
* <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>.</p>
66+
* <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>
67+
* in the <i>Amazon CloudFront API Reference</i>. </p>
6668
* </li>
6769
* </ul>
6870
* </li>

0 commit comments

Comments
 (0)