@aws-sdk/client-wafv2 3.310.0 → 3.312.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -79,7 +79,7 @@ import { WAFV2Client } from "./WAFV2Client";
79
79
  * <ul>
80
80
  * <li>
81
81
  * <p>For regional applications, you can use any of the endpoints in the list.
82
- * 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>
82
+ * 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>
83
83
  * </li>
84
84
  * <li>
85
85
  * <p>For Amazon CloudFront applications, you must use the API endpoint listed for
@@ -113,10 +113,10 @@ export declare class WAFV2 extends WAFV2Client {
113
113
  /**
114
114
  * @public
115
115
  * <p>Associates a web ACL with a regional application resource, to protect the resource.
116
- * 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>
116
+ * 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>
117
117
  * <p>For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To
118
118
  * associate a web ACL, in the CloudFront call <code>UpdateDistribution</code>, set the web ACL ID
119
- * 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>
119
+ * 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>
120
120
  * <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>
121
121
  */
122
122
  associateWebACL(args: AssociateWebACLCommandInput, options?: __HttpHandlerOptions): Promise<AssociateWebACLCommandOutput>;
@@ -134,8 +134,8 @@ export declare class WAFV2 extends WAFV2Client {
134
134
  * Simple rules that cost little to run use fewer WCUs than more complex rules
135
135
  * that use more processing power.
136
136
  * Rule group capacity is fixed at creation, which helps users plan their
137
- * web ACL WCU usage when they use a rule group.
138
- * The WCU limit for web ACLs is 1,500. </p>
137
+ * 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>
138
+ * in the <i>WAF Developer Guide</i>. </p>
139
139
  */
140
140
  checkCapacity(args: CheckCapacityCommandInput, options?: __HttpHandlerOptions): Promise<CheckCapacityCommandOutput>;
141
141
  checkCapacity(args: CheckCapacityCommandInput, cb: (err: any, data?: CheckCapacityCommandOutput) => void): void;
@@ -169,7 +169,7 @@ export declare class WAFV2 extends WAFV2Client {
169
169
  /**
170
170
  * @public
171
171
  * <p>Creates a <a>WebACL</a> per the specifications provided.</p>
172
- * <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>
172
+ * <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>
173
173
  */
174
174
  createWebACL(args: CreateWebACLCommandInput, options?: __HttpHandlerOptions): Promise<CreateWebACLCommandOutput>;
175
175
  createWebACL(args: CreateWebACLCommandInput, cb: (err: any, data?: CreateWebACLCommandOutput) => void): void;
@@ -236,7 +236,8 @@ export declare class WAFV2 extends WAFV2Client {
236
236
  * </li>
237
237
  * <li>
238
238
  * <p>For Amazon CloudFront distributions, use the CloudFront call
239
- * <code>ListDistributionsByWebACLId</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html">ListDistributionsByWebACLId</a>.</p>
239
+ * <code>ListDistributionsByWebACLId</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html">ListDistributionsByWebACLId</a>
240
+ * in the <i>Amazon CloudFront API Reference</i>. </p>
240
241
  * </li>
241
242
  * </ul>
242
243
  * </li>
@@ -248,7 +249,8 @@ export declare class WAFV2 extends WAFV2Client {
248
249
  * </li>
249
250
  * <li>
250
251
  * <p>For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call
251
- * <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>.</p>
252
+ * <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>
253
+ * in the <i>Amazon CloudFront API Reference</i>. </p>
252
254
  * </li>
253
255
  * </ul>
254
256
  * </li>
@@ -269,10 +271,10 @@ export declare class WAFV2 extends WAFV2Client {
269
271
  /**
270
272
  * @public
271
273
  * <p>Disassociates the specified regional application resource from any existing web ACL
272
- * 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>
274
+ * 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>
273
275
  * <p>For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To
274
276
  * disassociate a web ACL, provide an empty web ACL ID in the CloudFront call
275
- * <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>.</p>
277
+ * <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>
276
278
  */
277
279
  disassociateWebACL(args: DisassociateWebACLCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateWebACLCommandOutput>;
278
280
  disassociateWebACL(args: DisassociateWebACLCommandInput, cb: (err: any, data?: DisassociateWebACLCommandOutput) => void): void;
@@ -713,7 +715,7 @@ export declare class WAFV2 extends WAFV2Client {
713
715
  * </ol>
714
716
  * </note>
715
717
  * <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>
716
- * <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>
718
+ * <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>
717
719
  */
718
720
  updateWebACL(args: UpdateWebACLCommandInput, options?: __HttpHandlerOptions): Promise<UpdateWebACLCommandOutput>;
719
721
  updateWebACL(args: UpdateWebACLCommandInput, cb: (err: any, data?: UpdateWebACLCommandOutput) => void): void;
@@ -220,7 +220,7 @@ export interface WAFV2ClientResolvedConfig extends WAFV2ClientResolvedConfigType
220
220
  * <ul>
221
221
  * <li>
222
222
  * <p>For regional applications, you can use any of the endpoints in the list.
223
- * 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>
223
+ * 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>
224
224
  * </li>
225
225
  * <li>
226
226
  * <p>For Amazon CloudFront applications, you must use the API endpoint listed for
@@ -20,10 +20,10 @@ export interface AssociateWebACLCommandOutput extends AssociateWebACLResponse, _
20
20
  /**
21
21
  * @public
22
22
  * <p>Associates a web ACL with a regional application resource, to protect the resource.
23
- * 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>
23
+ * 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>
24
24
  * <p>For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To
25
25
  * associate a web ACL, in the CloudFront call <code>UpdateDistribution</code>, set the web ACL ID
26
- * 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>
26
+ * 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>
27
27
  * <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>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -29,8 +29,8 @@ export interface CheckCapacityCommandOutput extends CheckCapacityResponse, __Met
29
29
  * Simple rules that cost little to run use fewer WCUs than more complex rules
30
30
  * that use more processing power.
31
31
  * Rule group capacity is fixed at creation, which helps users plan their
32
- * web ACL WCU usage when they use a rule group.
33
- * The WCU limit for web ACLs is 1,500. </p>
32
+ * 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>
33
+ * in the <i>WAF Developer Guide</i>. </p>
34
34
  * @example
35
35
  * Use a bare-bones client and the command you need to make an API call.
36
36
  * ```javascript
@@ -20,7 +20,7 @@ export interface CreateWebACLCommandOutput extends CreateWebACLResponse, __Metad
20
20
  /**
21
21
  * @public
22
22
  * <p>Creates a <a>WebACL</a> per the specifications provided.</p>
23
- * <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>
23
+ * <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>
24
24
  * @example
25
25
  * Use a bare-bones client and the command you need to make an API call.
26
26
  * ```javascript
@@ -786,6 +786,13 @@ export interface CreateWebACLCommandOutput extends CreateWebACLResponse, __Metad
786
786
  * TokenDomains: [ // TokenDomains
787
787
  * "STRING_VALUE",
788
788
  * ],
789
+ * AssociationConfig: { // AssociationConfig
790
+ * RequestBody: { // RequestBody
791
+ * "<keys>": { // RequestBodyAssociatedResourceTypeConfig
792
+ * DefaultSizeInspectionLimit: "KB_16" || "KB_32" || "KB_48" || "KB_64", // required
793
+ * },
794
+ * },
795
+ * },
789
796
  * };
790
797
  * const command = new CreateWebACLCommand(input);
791
798
  * const response = await client.send(command);
@@ -34,7 +34,8 @@ export interface DeleteWebACLCommandOutput extends DeleteWebACLResponse, __Metad
34
34
  * </li>
35
35
  * <li>
36
36
  * <p>For Amazon CloudFront distributions, use the CloudFront call
37
- * <code>ListDistributionsByWebACLId</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html">ListDistributionsByWebACLId</a>.</p>
37
+ * <code>ListDistributionsByWebACLId</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html">ListDistributionsByWebACLId</a>
38
+ * in the <i>Amazon CloudFront API Reference</i>. </p>
38
39
  * </li>
39
40
  * </ul>
40
41
  * </li>
@@ -46,7 +47,8 @@ export interface DeleteWebACLCommandOutput extends DeleteWebACLResponse, __Metad
46
47
  * </li>
47
48
  * <li>
48
49
  * <p>For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call
49
- * <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>.</p>
50
+ * <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>
51
+ * in the <i>Amazon CloudFront API Reference</i>. </p>
50
52
  * </li>
51
53
  * </ul>
52
54
  * </li>
@@ -20,10 +20,10 @@ export interface DisassociateWebACLCommandOutput extends DisassociateWebACLRespo
20
20
  /**
21
21
  * @public
22
22
  * <p>Disassociates the specified regional application resource from any existing web ACL
23
- * 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>
23
+ * 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>
24
24
  * <p>For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To
25
25
  * disassociate a web ACL, provide an empty web ACL ID in the CloudFront call
26
- * <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>.</p>
26
+ * <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>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
29
29
  * ```javascript
@@ -86,7 +86,7 @@ export interface PutPermissionPolicyCommandOutput extends PutPermissionPolicyRes
86
86
  * <p>The policy specifications must conform to the following:</p>
87
87
  * <ul>
88
88
  * <li>
89
- * <p>The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.</p>
89
+ * <p>The policy must be composed using IAM Policy version 2012-10-17.</p>
90
90
  * </li>
91
91
  * <li>
92
92
  * <p>The policy must include specifications for <code>Effect</code>, <code>Action</code>, and <code>Principal</code>.</p>
@@ -38,7 +38,7 @@ export interface UpdateWebACLCommandOutput extends UpdateWebACLResponse, __Metad
38
38
  * </ol>
39
39
  * </note>
40
40
  * <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>
41
- * <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>
41
+ * <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>
42
42
  * @example
43
43
  * Use a bare-bones client and the command you need to make an API call.
44
44
  * ```javascript
@@ -800,6 +800,13 @@ export interface UpdateWebACLCommandOutput extends UpdateWebACLResponse, __Metad
800
800
  * TokenDomains: [ // TokenDomains
801
801
  * "STRING_VALUE",
802
802
  * ],
803
+ * AssociationConfig: { // AssociationConfig
804
+ * RequestBody: { // RequestBody
805
+ * "<keys>": { // RequestBodyAssociatedResourceTypeConfig
806
+ * DefaultSizeInspectionLimit: "KB_16" || "KB_32" || "KB_48" || "KB_64", // required
807
+ * },
808
+ * },
809
+ * },
803
810
  * };
804
811
  * const command = new UpdateWebACLCommand(input);
805
812
  * const response = await client.send(command);