@aws-sdk/client-wafv2 3.744.0 → 3.749.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.
- package/README.md +5 -5
- package/dist-cjs/index.js +19 -0
- package/dist-es/models/models_0.js +12 -0
- package/dist-es/protocols/Aws_json1_1.js +3 -0
- package/dist-types/WAFV2.d.ts +5 -5
- package/dist-types/WAFV2Client.d.ts +5 -5
- package/dist-types/commands/AssociateWebACLCommand.d.ts +3 -6
- package/dist-types/commands/CheckCapacityCommand.d.ts +1 -1
- package/dist-types/commands/CreateRuleGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateWebACLCommand.d.ts +17 -2
- package/dist-types/commands/DeleteWebACLCommand.d.ts +6 -6
- package/dist-types/commands/DisassociateWebACLCommand.d.ts +3 -5
- package/dist-types/commands/GetWebACLCommand.d.ts +15 -0
- package/dist-types/commands/GetWebACLForResourceCommand.d.ts +16 -1
- package/dist-types/commands/ListResourcesForWebACLCommand.d.ts +1 -1
- package/dist-types/commands/PutLoggingConfigurationCommand.d.ts +1 -0
- package/dist-types/commands/UpdateRuleGroupCommand.d.ts +1 -1
- package/dist-types/commands/UpdateWebACLCommand.d.ts +17 -2
- package/dist-types/index.d.ts +5 -5
- package/dist-types/models/models_0.d.ts +194 -46
- package/dist-types/ts3.4/models/models_0.d.ts +32 -0
- package/package.json +11 -11
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript WAFV2 Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<fullname>WAF</fullname>
|
|
9
|
+
<fullname>WAF </fullname>
|
|
10
10
|
<note>
|
|
11
11
|
|
|
12
12
|
<p>This is the latest version of the <b>WAF</b> API,
|
|
@@ -20,8 +20,8 @@ WAF resources that you created before. WAF Classic support will end on September
|
|
|
20
20
|
see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">WAF Developer Guide</a>. </p>
|
|
21
21
|
</note>
|
|
22
22
|
<p>WAF is a web application firewall that lets you monitor the HTTP and HTTPS
|
|
23
|
-
requests that are forwarded to
|
|
24
|
-
GraphQL API, Amazon Cognito user pool, App Runner service,
|
|
23
|
+
requests that are forwarded to a protected resource. Protected resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync
|
|
24
|
+
GraphQL API, Amazon Cognito user pool, App Runner service, and Amazon Web Services Verified Access instance. WAF also lets you control access to your content,
|
|
25
25
|
to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that
|
|
26
26
|
you specify, such as the IP addresses that requests originate from or the values of query
|
|
27
27
|
strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code
|
|
@@ -33,11 +33,11 @@ Guide</a>.</p>
|
|
|
33
33
|
<p>You can make calls using the endpoints listed in <a href="https://docs.aws.amazon.com/general/latest/gr/waf.html">WAF endpoints and quotas</a>. </p>
|
|
34
34
|
<ul>
|
|
35
35
|
<li>
|
|
36
|
-
<p>For regional
|
|
36
|
+
<p>For regional resources, you can use any of the endpoints in the list.
|
|
37
37
|
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, an App Runner service, or an Amazon Web Services Verified Access instance. </p>
|
|
38
38
|
</li>
|
|
39
39
|
<li>
|
|
40
|
-
<p>For Amazon CloudFront
|
|
40
|
+
<p>For Amazon CloudFront, you must use the API endpoint listed for
|
|
41
41
|
US East (N. Virginia): us-east-1.</p>
|
|
42
42
|
</li>
|
|
43
43
|
</ul>
|
package/dist-cjs/index.js
CHANGED
|
@@ -33,6 +33,7 @@ __export(src_exports, {
|
|
|
33
33
|
CreateRegexPatternSetCommand: () => CreateRegexPatternSetCommand,
|
|
34
34
|
CreateRuleGroupCommand: () => CreateRuleGroupCommand,
|
|
35
35
|
CreateWebACLCommand: () => CreateWebACLCommand,
|
|
36
|
+
DataProtectionAction: () => DataProtectionAction,
|
|
36
37
|
DeleteAPIKeyCommand: () => DeleteAPIKeyCommand,
|
|
37
38
|
DeleteFirewallManagerRuleGroupsCommand: () => DeleteFirewallManagerRuleGroupsCommand,
|
|
38
39
|
DeleteIPSetCommand: () => DeleteIPSetCommand,
|
|
@@ -47,6 +48,7 @@ __export(src_exports, {
|
|
|
47
48
|
DisassociateWebACLCommand: () => DisassociateWebACLCommand,
|
|
48
49
|
FailureReason: () => FailureReason,
|
|
49
50
|
FallbackBehavior: () => FallbackBehavior,
|
|
51
|
+
FieldToProtectType: () => FieldToProtectType,
|
|
50
52
|
FilterBehavior: () => FilterBehavior,
|
|
51
53
|
FilterRequirement: () => FilterRequirement,
|
|
52
54
|
ForwardedIPPosition: () => ForwardedIPPosition,
|
|
@@ -712,6 +714,7 @@ var ParameterExceptionField = {
|
|
|
712
714
|
CUSTOM_REQUEST_HANDLING: "CUSTOM_REQUEST_HANDLING",
|
|
713
715
|
CUSTOM_RESPONSE: "CUSTOM_RESPONSE",
|
|
714
716
|
CUSTOM_RESPONSE_BODY: "CUSTOM_RESPONSE_BODY",
|
|
717
|
+
DATA_PROTECTION_CONFIG: "DATA_PROTECTION_CONFIG",
|
|
715
718
|
DEFAULT_ACTION: "DEFAULT_ACTION",
|
|
716
719
|
ENTITY_LIMIT: "ENTITY_LIMIT",
|
|
717
720
|
EXCLUDED_RULE: "EXCLUDED_RULE",
|
|
@@ -1030,6 +1033,17 @@ var ResponseContentType = {
|
|
|
1030
1033
|
TEXT_HTML: "TEXT_HTML",
|
|
1031
1034
|
TEXT_PLAIN: "TEXT_PLAIN"
|
|
1032
1035
|
};
|
|
1036
|
+
var DataProtectionAction = {
|
|
1037
|
+
HASH: "HASH",
|
|
1038
|
+
SUBSTITUTION: "SUBSTITUTION"
|
|
1039
|
+
};
|
|
1040
|
+
var FieldToProtectType = {
|
|
1041
|
+
BODY: "BODY",
|
|
1042
|
+
QUERY_STRING: "QUERY_STRING",
|
|
1043
|
+
SINGLE_COOKIE: "SINGLE_COOKIE",
|
|
1044
|
+
SINGLE_HEADER: "SINGLE_HEADER",
|
|
1045
|
+
SINGLE_QUERY_ARGUMENT: "SINGLE_QUERY_ARGUMENT"
|
|
1046
|
+
};
|
|
1033
1047
|
var WAFConfigurationWarningException = class _WAFConfigurationWarningException extends WAFV2ServiceException {
|
|
1034
1048
|
static {
|
|
1035
1049
|
__name(this, "WAFConfigurationWarningException");
|
|
@@ -2490,6 +2504,7 @@ var se_CreateWebACLRequest = /* @__PURE__ */ __name((input, context) => {
|
|
|
2490
2504
|
CaptchaConfig: import_smithy_client._json,
|
|
2491
2505
|
ChallengeConfig: import_smithy_client._json,
|
|
2492
2506
|
CustomResponseBodies: import_smithy_client._json,
|
|
2507
|
+
DataProtectionConfig: import_smithy_client._json,
|
|
2493
2508
|
DefaultAction: import_smithy_client._json,
|
|
2494
2509
|
Description: [],
|
|
2495
2510
|
Name: [],
|
|
@@ -2616,6 +2631,7 @@ var se_UpdateWebACLRequest = /* @__PURE__ */ __name((input, context) => {
|
|
|
2616
2631
|
CaptchaConfig: import_smithy_client._json,
|
|
2617
2632
|
ChallengeConfig: import_smithy_client._json,
|
|
2618
2633
|
CustomResponseBodies: import_smithy_client._json,
|
|
2634
|
+
DataProtectionConfig: import_smithy_client._json,
|
|
2619
2635
|
DefaultAction: import_smithy_client._json,
|
|
2620
2636
|
Description: [],
|
|
2621
2637
|
Id: [],
|
|
@@ -2931,6 +2947,7 @@ var de_WebACL = /* @__PURE__ */ __name((output, context) => {
|
|
|
2931
2947
|
CaptchaConfig: import_smithy_client._json,
|
|
2932
2948
|
ChallengeConfig: import_smithy_client._json,
|
|
2933
2949
|
CustomResponseBodies: import_smithy_client._json,
|
|
2950
|
+
DataProtectionConfig: import_smithy_client._json,
|
|
2934
2951
|
DefaultAction: import_smithy_client._json,
|
|
2935
2952
|
Description: import_smithy_client.expectString,
|
|
2936
2953
|
Id: import_smithy_client.expectString,
|
|
@@ -3945,6 +3962,8 @@ var WAFV2 = class extends WAFV2Client {
|
|
|
3945
3962
|
WAFTagOperationException,
|
|
3946
3963
|
WAFTagOperationInternalErrorException,
|
|
3947
3964
|
ResponseContentType,
|
|
3965
|
+
DataProtectionAction,
|
|
3966
|
+
FieldToProtectType,
|
|
3948
3967
|
WAFConfigurationWarningException,
|
|
3949
3968
|
WAFAssociatedItemException,
|
|
3950
3969
|
LogScope,
|
|
@@ -398,6 +398,7 @@ export const ParameterExceptionField = {
|
|
|
398
398
|
CUSTOM_REQUEST_HANDLING: "CUSTOM_REQUEST_HANDLING",
|
|
399
399
|
CUSTOM_RESPONSE: "CUSTOM_RESPONSE",
|
|
400
400
|
CUSTOM_RESPONSE_BODY: "CUSTOM_RESPONSE_BODY",
|
|
401
|
+
DATA_PROTECTION_CONFIG: "DATA_PROTECTION_CONFIG",
|
|
401
402
|
DEFAULT_ACTION: "DEFAULT_ACTION",
|
|
402
403
|
ENTITY_LIMIT: "ENTITY_LIMIT",
|
|
403
404
|
EXCLUDED_RULE: "EXCLUDED_RULE",
|
|
@@ -634,6 +635,17 @@ export const ResponseContentType = {
|
|
|
634
635
|
TEXT_HTML: "TEXT_HTML",
|
|
635
636
|
TEXT_PLAIN: "TEXT_PLAIN",
|
|
636
637
|
};
|
|
638
|
+
export const DataProtectionAction = {
|
|
639
|
+
HASH: "HASH",
|
|
640
|
+
SUBSTITUTION: "SUBSTITUTION",
|
|
641
|
+
};
|
|
642
|
+
export const FieldToProtectType = {
|
|
643
|
+
BODY: "BODY",
|
|
644
|
+
QUERY_STRING: "QUERY_STRING",
|
|
645
|
+
SINGLE_COOKIE: "SINGLE_COOKIE",
|
|
646
|
+
SINGLE_HEADER: "SINGLE_HEADER",
|
|
647
|
+
SINGLE_QUERY_ARGUMENT: "SINGLE_QUERY_ARGUMENT",
|
|
648
|
+
};
|
|
637
649
|
export class WAFConfigurationWarningException extends __BaseException {
|
|
638
650
|
name = "WAFConfigurationWarningException";
|
|
639
651
|
$fault = "client";
|
|
@@ -1310,6 +1310,7 @@ const se_CreateWebACLRequest = (input, context) => {
|
|
|
1310
1310
|
CaptchaConfig: _json,
|
|
1311
1311
|
ChallengeConfig: _json,
|
|
1312
1312
|
CustomResponseBodies: _json,
|
|
1313
|
+
DataProtectionConfig: _json,
|
|
1313
1314
|
DefaultAction: _json,
|
|
1314
1315
|
Description: [],
|
|
1315
1316
|
Name: [],
|
|
@@ -1440,6 +1441,7 @@ const se_UpdateWebACLRequest = (input, context) => {
|
|
|
1440
1441
|
CaptchaConfig: _json,
|
|
1441
1442
|
ChallengeConfig: _json,
|
|
1442
1443
|
CustomResponseBodies: _json,
|
|
1444
|
+
DataProtectionConfig: _json,
|
|
1443
1445
|
DefaultAction: _json,
|
|
1444
1446
|
Description: [],
|
|
1445
1447
|
Id: [],
|
|
@@ -1769,6 +1771,7 @@ const de_WebACL = (output, context) => {
|
|
|
1769
1771
|
CaptchaConfig: _json,
|
|
1770
1772
|
ChallengeConfig: _json,
|
|
1771
1773
|
CustomResponseBodies: _json,
|
|
1774
|
+
DataProtectionConfig: _json,
|
|
1772
1775
|
DefaultAction: _json,
|
|
1773
1776
|
Description: __expectString,
|
|
1774
1777
|
Id: __expectString,
|
package/dist-types/WAFV2.d.ts
CHANGED
|
@@ -382,7 +382,7 @@ export interface WAFV2 {
|
|
|
382
382
|
updateWebACL(args: UpdateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWebACLCommandOutput) => void): void;
|
|
383
383
|
}
|
|
384
384
|
/**
|
|
385
|
-
* <fullname>WAF</fullname>
|
|
385
|
+
* <fullname>WAF </fullname>
|
|
386
386
|
* <note>
|
|
387
387
|
* <p>This is the latest version of the <b>WAF</b> API,
|
|
388
388
|
* released in November, 2019. The names of the entities that you use to access this API,
|
|
@@ -395,8 +395,8 @@ export interface WAFV2 {
|
|
|
395
395
|
* see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">WAF Developer Guide</a>. </p>
|
|
396
396
|
* </note>
|
|
397
397
|
* <p>WAF is a web application firewall that lets you monitor the HTTP and HTTPS
|
|
398
|
-
* requests that are forwarded to
|
|
399
|
-
* GraphQL API, Amazon Cognito user pool, App Runner service,
|
|
398
|
+
* requests that are forwarded to a protected resource. Protected resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync
|
|
399
|
+
* GraphQL API, Amazon Cognito user pool, App Runner service, and Amazon Web Services Verified Access instance. WAF also lets you control access to your content,
|
|
400
400
|
* to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that
|
|
401
401
|
* you specify, such as the IP addresses that requests originate from or the values of query
|
|
402
402
|
* strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code
|
|
@@ -408,11 +408,11 @@ export interface WAFV2 {
|
|
|
408
408
|
* <p>You can make calls using the endpoints listed in <a href="https://docs.aws.amazon.com/general/latest/gr/waf.html">WAF endpoints and quotas</a>. </p>
|
|
409
409
|
* <ul>
|
|
410
410
|
* <li>
|
|
411
|
-
* <p>For regional
|
|
411
|
+
* <p>For regional resources, you can use any of the endpoints in the list.
|
|
412
412
|
* 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, an App Runner service, or an Amazon Web Services Verified Access instance. </p>
|
|
413
413
|
* </li>
|
|
414
414
|
* <li>
|
|
415
|
-
* <p>For Amazon CloudFront
|
|
415
|
+
* <p>For Amazon CloudFront, you must use the API endpoint listed for
|
|
416
416
|
* US East (N. Virginia): us-east-1.</p>
|
|
417
417
|
* </li>
|
|
418
418
|
* </ul>
|
|
@@ -223,7 +223,7 @@ export type WAFV2ClientResolvedConfigType = __SmithyResolvedConfiguration<__Http
|
|
|
223
223
|
export interface WAFV2ClientResolvedConfig extends WAFV2ClientResolvedConfigType {
|
|
224
224
|
}
|
|
225
225
|
/**
|
|
226
|
-
* <fullname>WAF</fullname>
|
|
226
|
+
* <fullname>WAF </fullname>
|
|
227
227
|
* <note>
|
|
228
228
|
* <p>This is the latest version of the <b>WAF</b> API,
|
|
229
229
|
* released in November, 2019. The names of the entities that you use to access this API,
|
|
@@ -236,8 +236,8 @@ export interface WAFV2ClientResolvedConfig extends WAFV2ClientResolvedConfigType
|
|
|
236
236
|
* see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">WAF Developer Guide</a>. </p>
|
|
237
237
|
* </note>
|
|
238
238
|
* <p>WAF is a web application firewall that lets you monitor the HTTP and HTTPS
|
|
239
|
-
* requests that are forwarded to
|
|
240
|
-
* GraphQL API, Amazon Cognito user pool, App Runner service,
|
|
239
|
+
* requests that are forwarded to a protected resource. Protected resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync
|
|
240
|
+
* GraphQL API, Amazon Cognito user pool, App Runner service, and Amazon Web Services Verified Access instance. WAF also lets you control access to your content,
|
|
241
241
|
* to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that
|
|
242
242
|
* you specify, such as the IP addresses that requests originate from or the values of query
|
|
243
243
|
* strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code
|
|
@@ -249,11 +249,11 @@ export interface WAFV2ClientResolvedConfig extends WAFV2ClientResolvedConfigType
|
|
|
249
249
|
* <p>You can make calls using the endpoints listed in <a href="https://docs.aws.amazon.com/general/latest/gr/waf.html">WAF endpoints and quotas</a>. </p>
|
|
250
250
|
* <ul>
|
|
251
251
|
* <li>
|
|
252
|
-
* <p>For regional
|
|
252
|
+
* <p>For regional resources, you can use any of the endpoints in the list.
|
|
253
253
|
* 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, an App Runner service, or an Amazon Web Services Verified Access instance. </p>
|
|
254
254
|
* </li>
|
|
255
255
|
* <li>
|
|
256
|
-
* <p>For Amazon CloudFront
|
|
256
|
+
* <p>For Amazon CloudFront, you must use the API endpoint listed for
|
|
257
257
|
* US East (N. Virginia): us-east-1.</p>
|
|
258
258
|
* </li>
|
|
259
259
|
* </ul>
|
|
@@ -27,11 +27,8 @@ declare const AssociateWebACLCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Associates a web ACL with a
|
|
31
|
-
*
|
|
32
|
-
* <p>For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To
|
|
33
|
-
* associate a web ACL, in the CloudFront call <code>UpdateDistribution</code>, set the web ACL ID
|
|
34
|
-
* 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>
|
|
30
|
+
* <p>Associates a web ACL with a resource, to protect the resource. </p>
|
|
31
|
+
* <p>Use this for all resource types except for Amazon CloudFront distributions. For Amazon CloudFront, call <code>UpdateDistribution</code> for the distribution and provide the Amazon Resource Name (ARN) of the web ACL in the web ACL ID. 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>
|
|
35
32
|
* <p>
|
|
36
33
|
* <b>Required permissions for customer-managed IAM policies</b>
|
|
37
34
|
* </p>
|
|
@@ -116,7 +113,7 @@ declare const AssociateWebACLCommand_base: {
|
|
|
116
113
|
* <p>WAF couldn’t retrieve a resource that you specified for this operation.
|
|
117
114
|
* If you've just created a resource that you're using in this operation, you might
|
|
118
115
|
* just need to wait a few minutes. It can take from a few seconds to a number of minutes
|
|
119
|
-
* for changes to propagate. Verify the
|
|
116
|
+
* for changes to propagate. Verify the resource specifications in your request
|
|
120
117
|
* parameters and then retry the operation.</p>
|
|
121
118
|
*
|
|
122
119
|
* @throws {@link WAFV2ServiceException}
|
|
@@ -1070,7 +1070,7 @@ declare const CheckCapacityCommand_base: {
|
|
|
1070
1070
|
* <p>WAF couldn’t retrieve a resource that you specified for this operation.
|
|
1071
1071
|
* If you've just created a resource that you're using in this operation, you might
|
|
1072
1072
|
* just need to wait a few minutes. It can take from a few seconds to a number of minutes
|
|
1073
|
-
* for changes to propagate. Verify the
|
|
1073
|
+
* for changes to propagate. Verify the resource specifications in your request
|
|
1074
1074
|
* parameters and then retry the operation.</p>
|
|
1075
1075
|
*
|
|
1076
1076
|
* @throws {@link WAFV2ServiceException}
|
|
@@ -1093,7 +1093,7 @@ declare const CreateRuleGroupCommand_base: {
|
|
|
1093
1093
|
* <p>WAF couldn’t retrieve a resource that you specified for this operation.
|
|
1094
1094
|
* If you've just created a resource that you're using in this operation, you might
|
|
1095
1095
|
* just need to wait a few minutes. It can take from a few seconds to a number of minutes
|
|
1096
|
-
* for changes to propagate. Verify the
|
|
1096
|
+
* for changes to propagate. Verify the resource specifications in your request
|
|
1097
1097
|
* parameters and then retry the operation.</p>
|
|
1098
1098
|
*
|
|
1099
1099
|
* @throws {@link WAFV2ServiceException}
|
|
@@ -28,7 +28,7 @@ declare const CreateWebACLCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Creates a <a>WebACL</a> per the specifications provided.</p>
|
|
31
|
-
* <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. 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
|
|
31
|
+
* <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. 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 resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, and Amazon Web Services Verified Access instance. </p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -983,6 +983,21 @@ declare const CreateWebACLCommand_base: {
|
|
|
983
983
|
* CloudWatchMetricsEnabled: true || false, // required
|
|
984
984
|
* MetricName: "STRING_VALUE", // required
|
|
985
985
|
* },
|
|
986
|
+
* DataProtectionConfig: { // DataProtectionConfig
|
|
987
|
+
* DataProtections: [ // DataProtections // required
|
|
988
|
+
* { // DataProtection
|
|
989
|
+
* Field: { // FieldToProtect
|
|
990
|
+
* FieldType: "SINGLE_HEADER" || "SINGLE_COOKIE" || "SINGLE_QUERY_ARGUMENT" || "QUERY_STRING" || "BODY", // required
|
|
991
|
+
* FieldKeys: [ // FieldToProtectKeys
|
|
992
|
+
* "STRING_VALUE",
|
|
993
|
+
* ],
|
|
994
|
+
* },
|
|
995
|
+
* Action: "SUBSTITUTION" || "HASH", // required
|
|
996
|
+
* ExcludeRuleMatchDetails: true || false,
|
|
997
|
+
* ExcludeRateBasedDetails: true || false,
|
|
998
|
+
* },
|
|
999
|
+
* ],
|
|
1000
|
+
* },
|
|
986
1001
|
* Tags: [ // TagList
|
|
987
1002
|
* { // Tag
|
|
988
1003
|
* Key: "STRING_VALUE", // required
|
|
@@ -1122,7 +1137,7 @@ declare const CreateWebACLCommand_base: {
|
|
|
1122
1137
|
* <p>WAF couldn’t retrieve a resource that you specified for this operation.
|
|
1123
1138
|
* If you've just created a resource that you're using in this operation, you might
|
|
1124
1139
|
* just need to wait a few minutes. It can take from a few seconds to a number of minutes
|
|
1125
|
-
* for changes to propagate. Verify the
|
|
1140
|
+
* for changes to propagate. Verify the resource specifications in your request
|
|
1126
1141
|
* parameters and then retry the operation.</p>
|
|
1127
1142
|
*
|
|
1128
1143
|
* @throws {@link WAFV2ServiceException}
|
|
@@ -37,26 +37,26 @@ declare const DeleteWebACLCommand_base: {
|
|
|
37
37
|
* following calls:</p>
|
|
38
38
|
* <ul>
|
|
39
39
|
* <li>
|
|
40
|
-
* <p>For regional resources, call <a>ListResourcesForWebACL</a>.</p>
|
|
41
|
-
* </li>
|
|
42
|
-
* <li>
|
|
43
40
|
* <p>For Amazon CloudFront distributions, use the CloudFront call
|
|
44
41
|
* <code>ListDistributionsByWebACLId</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html">ListDistributionsByWebACLId</a>
|
|
45
42
|
* in the <i>Amazon CloudFront API Reference</i>. </p>
|
|
46
43
|
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>For all other resources, call <a>ListResourcesForWebACL</a>.</p>
|
|
46
|
+
* </li>
|
|
47
47
|
* </ul>
|
|
48
48
|
* </li>
|
|
49
49
|
* <li>
|
|
50
50
|
* <p>To disassociate a resource from a web ACL, use the following calls:</p>
|
|
51
51
|
* <ul>
|
|
52
52
|
* <li>
|
|
53
|
-
* <p>For regional resources, call <a>DisassociateWebACL</a>.</p>
|
|
54
|
-
* </li>
|
|
55
|
-
* <li>
|
|
56
53
|
* <p>For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call
|
|
57
54
|
* <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>
|
|
58
55
|
* in the <i>Amazon CloudFront API Reference</i>. </p>
|
|
59
56
|
* </li>
|
|
57
|
+
* <li>
|
|
58
|
+
* <p>For all other resources, call <a>DisassociateWebACL</a>.</p>
|
|
59
|
+
* </li>
|
|
60
60
|
* </ul>
|
|
61
61
|
* </li>
|
|
62
62
|
* </ul>
|
|
@@ -27,11 +27,9 @@ declare const DisassociateWebACLCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Disassociates the specified
|
|
31
|
-
* association
|
|
32
|
-
* <p>For Amazon CloudFront,
|
|
33
|
-
* disassociate a web ACL, provide an empty web ACL ID in the CloudFront call
|
|
34
|
-
* <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>
|
|
30
|
+
* <p>Disassociates the specified resource from its web ACL
|
|
31
|
+
* association, if it has one. </p>
|
|
32
|
+
* <p>Use this for all resource types except for Amazon CloudFront distributions. For Amazon CloudFront, call <code>UpdateDistribution</code> for the distribution and provide an empty web ACL ID. 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>
|
|
35
33
|
* <p>
|
|
36
34
|
* <b>Required permissions for customer-managed IAM policies</b>
|
|
37
35
|
* </p>
|
|
@@ -991,6 +991,21 @@ declare const GetWebACLCommand_base: {
|
|
|
991
991
|
* // CloudWatchMetricsEnabled: true || false, // required
|
|
992
992
|
* // MetricName: "STRING_VALUE", // required
|
|
993
993
|
* // },
|
|
994
|
+
* // DataProtectionConfig: { // DataProtectionConfig
|
|
995
|
+
* // DataProtections: [ // DataProtections // required
|
|
996
|
+
* // { // DataProtection
|
|
997
|
+
* // Field: { // FieldToProtect
|
|
998
|
+
* // FieldType: "SINGLE_HEADER" || "SINGLE_COOKIE" || "SINGLE_QUERY_ARGUMENT" || "QUERY_STRING" || "BODY", // required
|
|
999
|
+
* // FieldKeys: [ // FieldToProtectKeys
|
|
1000
|
+
* // "STRING_VALUE",
|
|
1001
|
+
* // ],
|
|
1002
|
+
* // },
|
|
1003
|
+
* // Action: "SUBSTITUTION" || "HASH", // required
|
|
1004
|
+
* // ExcludeRuleMatchDetails: true || false,
|
|
1005
|
+
* // ExcludeRateBasedDetails: true || false,
|
|
1006
|
+
* // },
|
|
1007
|
+
* // ],
|
|
1008
|
+
* // },
|
|
994
1009
|
* // Capacity: Number("long"),
|
|
995
1010
|
* // PreProcessFirewallManagerRuleGroups: [ // FirewallManagerRuleGroups
|
|
996
1011
|
* // { // FirewallManagerRuleGroup
|
|
@@ -999,6 +999,21 @@ declare const GetWebACLForResourceCommand_base: {
|
|
|
999
999
|
* // CloudWatchMetricsEnabled: true || false, // required
|
|
1000
1000
|
* // MetricName: "STRING_VALUE", // required
|
|
1001
1001
|
* // },
|
|
1002
|
+
* // DataProtectionConfig: { // DataProtectionConfig
|
|
1003
|
+
* // DataProtections: [ // DataProtections // required
|
|
1004
|
+
* // { // DataProtection
|
|
1005
|
+
* // Field: { // FieldToProtect
|
|
1006
|
+
* // FieldType: "SINGLE_HEADER" || "SINGLE_COOKIE" || "SINGLE_QUERY_ARGUMENT" || "QUERY_STRING" || "BODY", // required
|
|
1007
|
+
* // FieldKeys: [ // FieldToProtectKeys
|
|
1008
|
+
* // "STRING_VALUE",
|
|
1009
|
+
* // ],
|
|
1010
|
+
* // },
|
|
1011
|
+
* // Action: "SUBSTITUTION" || "HASH", // required
|
|
1012
|
+
* // ExcludeRuleMatchDetails: true || false,
|
|
1013
|
+
* // ExcludeRateBasedDetails: true || false,
|
|
1014
|
+
* // },
|
|
1015
|
+
* // ],
|
|
1016
|
+
* // },
|
|
1002
1017
|
* // Capacity: Number("long"),
|
|
1003
1018
|
* // PreProcessFirewallManagerRuleGroups: [ // FirewallManagerRuleGroups
|
|
1004
1019
|
* // { // FirewallManagerRuleGroup
|
|
@@ -1274,7 +1289,7 @@ declare const GetWebACLForResourceCommand_base: {
|
|
|
1274
1289
|
* <p>WAF couldn’t retrieve a resource that you specified for this operation.
|
|
1275
1290
|
* If you've just created a resource that you're using in this operation, you might
|
|
1276
1291
|
* just need to wait a few minutes. It can take from a few seconds to a number of minutes
|
|
1277
|
-
* for changes to propagate. Verify the
|
|
1292
|
+
* for changes to propagate. Verify the resource specifications in your request
|
|
1278
1293
|
* parameters and then retry the operation.</p>
|
|
1279
1294
|
*
|
|
1280
1295
|
* @throws {@link WAFV2ServiceException}
|
|
@@ -27,7 +27,7 @@ declare const ListResourcesForWebACLCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves an array of the Amazon Resource Names (ARNs) for the
|
|
30
|
+
* <p>Retrieves an array of the Amazon Resource Names (ARNs) for the resources that
|
|
31
31
|
* are associated with the specified web ACL. </p>
|
|
32
32
|
* <p>For Amazon CloudFront, don't use this call. Instead, use the CloudFront call
|
|
33
33
|
* <code>ListDistributionsByWebACLId</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html">ListDistributionsByWebACLId</a>
|
|
@@ -29,6 +29,7 @@ declare const PutLoggingConfigurationCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Enables the specified <a>LoggingConfiguration</a>, to start logging from a
|
|
31
31
|
* web ACL, according to the configuration provided. </p>
|
|
32
|
+
* <p>If you configure data protection for the web ACL, the protection applies to the data that WAF sends to the logs. </p>
|
|
32
33
|
* <note>
|
|
33
34
|
* <p>This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call. </p>
|
|
34
35
|
* <p>To modify an existing logging configuration, do the following: </p>
|
|
@@ -1123,7 +1123,7 @@ declare const UpdateRuleGroupCommand_base: {
|
|
|
1123
1123
|
* <p>WAF couldn’t retrieve a resource that you specified for this operation.
|
|
1124
1124
|
* If you've just created a resource that you're using in this operation, you might
|
|
1125
1125
|
* just need to wait a few minutes. It can take from a few seconds to a number of minutes
|
|
1126
|
-
* for changes to propagate. Verify the
|
|
1126
|
+
* for changes to propagate. Verify the resource specifications in your request
|
|
1127
1127
|
* parameters and then retry the operation.</p>
|
|
1128
1128
|
*
|
|
1129
1129
|
* @throws {@link WAFV2ServiceException}
|
|
@@ -45,7 +45,7 @@ declare const UpdateWebACLCommand_base: {
|
|
|
45
45
|
* </li>
|
|
46
46
|
* </ol>
|
|
47
47
|
* </note>
|
|
48
|
-
* <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. 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
|
|
48
|
+
* <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. 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 resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, and Amazon Web Services Verified Access instance. </p>
|
|
49
49
|
* <p>
|
|
50
50
|
* <b>Temporary inconsistencies during updates</b>
|
|
51
51
|
* </p>
|
|
@@ -1020,6 +1020,21 @@ declare const UpdateWebACLCommand_base: {
|
|
|
1020
1020
|
* CloudWatchMetricsEnabled: true || false, // required
|
|
1021
1021
|
* MetricName: "STRING_VALUE", // required
|
|
1022
1022
|
* },
|
|
1023
|
+
* DataProtectionConfig: { // DataProtectionConfig
|
|
1024
|
+
* DataProtections: [ // DataProtections // required
|
|
1025
|
+
* { // DataProtection
|
|
1026
|
+
* Field: { // FieldToProtect
|
|
1027
|
+
* FieldType: "SINGLE_HEADER" || "SINGLE_COOKIE" || "SINGLE_QUERY_ARGUMENT" || "QUERY_STRING" || "BODY", // required
|
|
1028
|
+
* FieldKeys: [ // FieldToProtectKeys
|
|
1029
|
+
* "STRING_VALUE",
|
|
1030
|
+
* ],
|
|
1031
|
+
* },
|
|
1032
|
+
* Action: "SUBSTITUTION" || "HASH", // required
|
|
1033
|
+
* ExcludeRuleMatchDetails: true || false,
|
|
1034
|
+
* ExcludeRateBasedDetails: true || false,
|
|
1035
|
+
* },
|
|
1036
|
+
* ],
|
|
1037
|
+
* },
|
|
1023
1038
|
* LockToken: "STRING_VALUE", // required
|
|
1024
1039
|
* CustomResponseBodies: { // CustomResponseBodies
|
|
1025
1040
|
* "<keys>": { // CustomResponseBody
|
|
@@ -1141,7 +1156,7 @@ declare const UpdateWebACLCommand_base: {
|
|
|
1141
1156
|
* <p>WAF couldn’t retrieve a resource that you specified for this operation.
|
|
1142
1157
|
* If you've just created a resource that you're using in this operation, you might
|
|
1143
1158
|
* just need to wait a few minutes. It can take from a few seconds to a number of minutes
|
|
1144
|
-
* for changes to propagate. Verify the
|
|
1159
|
+
* for changes to propagate. Verify the resource specifications in your request
|
|
1145
1160
|
* parameters and then retry the operation.</p>
|
|
1146
1161
|
*
|
|
1147
1162
|
* @throws {@link WAFV2ServiceException}
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <fullname>WAF</fullname>
|
|
2
|
+
* <fullname>WAF </fullname>
|
|
3
3
|
* <note>
|
|
4
4
|
* <p>This is the latest version of the <b>WAF</b> API,
|
|
5
5
|
* released in November, 2019. The names of the entities that you use to access this API,
|
|
@@ -12,8 +12,8 @@
|
|
|
12
12
|
* see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">WAF Developer Guide</a>. </p>
|
|
13
13
|
* </note>
|
|
14
14
|
* <p>WAF is a web application firewall that lets you monitor the HTTP and HTTPS
|
|
15
|
-
* requests that are forwarded to
|
|
16
|
-
* GraphQL API, Amazon Cognito user pool, App Runner service,
|
|
15
|
+
* requests that are forwarded to a protected resource. Protected resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync
|
|
16
|
+
* GraphQL API, Amazon Cognito user pool, App Runner service, and Amazon Web Services Verified Access instance. WAF also lets you control access to your content,
|
|
17
17
|
* to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that
|
|
18
18
|
* you specify, such as the IP addresses that requests originate from or the values of query
|
|
19
19
|
* strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code
|
|
@@ -25,11 +25,11 @@
|
|
|
25
25
|
* <p>You can make calls using the endpoints listed in <a href="https://docs.aws.amazon.com/general/latest/gr/waf.html">WAF endpoints and quotas</a>. </p>
|
|
26
26
|
* <ul>
|
|
27
27
|
* <li>
|
|
28
|
-
* <p>For regional
|
|
28
|
+
* <p>For regional resources, you can use any of the endpoints in the list.
|
|
29
29
|
* 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, an App Runner service, or an Amazon Web Services Verified Access instance. </p>
|
|
30
30
|
* </li>
|
|
31
31
|
* <li>
|
|
32
|
-
* <p>For Amazon CloudFront
|
|
32
|
+
* <p>For Amazon CloudFront, you must use the API endpoint listed for
|
|
33
33
|
* US East (N. Virginia): us-east-1.</p>
|
|
34
34
|
* </li>
|
|
35
35
|
* </ul>
|