aws-sdk-wafv2 1.53.0 → 1.54.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-wafv2/client.rb +148 -84
- data/lib/aws-sdk-wafv2/client_api.rb +17 -0
- data/lib/aws-sdk-wafv2/types.rb +353 -193
- data/lib/aws-sdk-wafv2.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-wafv2/types.rb
CHANGED
@@ -63,7 +63,8 @@ module Aws::WAFV2
|
|
63
63
|
# The inspection level to use for the Bot Control rule group. The
|
64
64
|
# common level is the least expensive. The targeted level includes all
|
65
65
|
# common level rules and adds rules with more advanced inspection
|
66
|
-
# criteria. For details, see [WAF Bot Control rule group][1]
|
66
|
+
# criteria. For details, see [WAF Bot Control rule group][1] in the
|
67
|
+
# *WAF Developer Guide*.
|
67
68
|
#
|
68
69
|
#
|
69
70
|
#
|
@@ -137,13 +138,12 @@ module Aws::WAFV2
|
|
137
138
|
# Defines custom handling for the web request.
|
138
139
|
#
|
139
140
|
# For information about customizing web requests and responses, see
|
140
|
-
# [Customizing web requests and responses in WAF][1] in the
|
141
|
-
# Developer Guide
|
141
|
+
# [Customizing web requests and responses in WAF][1] in the *WAF
|
142
|
+
# Developer Guide*.
|
142
143
|
#
|
143
144
|
#
|
144
145
|
#
|
145
146
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
|
146
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
|
147
147
|
# @return [Types::CustomRequestHandling]
|
148
148
|
#
|
149
149
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/AllowAction AWS API Documentation
|
@@ -183,20 +183,22 @@ module Aws::WAFV2
|
|
183
183
|
# The ARN must be in one of the following formats:
|
184
184
|
#
|
185
185
|
# * For an Application Load Balancer:
|
186
|
-
# `arn:
|
186
|
+
# `arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
|
187
187
|
# `
|
188
188
|
#
|
189
189
|
# * For an Amazon API Gateway REST API:
|
190
|
-
# `arn:
|
190
|
+
# `arn:partition:apigateway:region::/restapis/api-id/stages/stage-name
|
191
|
+
# `
|
191
192
|
#
|
192
193
|
# * For an AppSync GraphQL API:
|
193
|
-
# `arn:
|
194
|
+
# `arn:partition:appsync:region:account-id:apis/GraphQLApiId `
|
194
195
|
#
|
195
196
|
# * For an Amazon Cognito user pool:
|
196
|
-
# `arn:
|
197
|
+
# `arn:partition:cognito-idp:region:account-id:userpool/user-pool-id
|
198
|
+
# `
|
197
199
|
#
|
198
200
|
# * For an App Runner service:
|
199
|
-
# `arn:
|
201
|
+
# `arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id
|
200
202
|
# `
|
201
203
|
# @return [String]
|
202
204
|
#
|
@@ -213,6 +215,47 @@ module Aws::WAFV2
|
|
213
215
|
#
|
214
216
|
class AssociateWebACLResponse < Aws::EmptyStructure; end
|
215
217
|
|
218
|
+
# Specifies custom configurations for the associations between the web
|
219
|
+
# ACL and protected resources.
|
220
|
+
#
|
221
|
+
# Use this to customize the maximum size of the request body that your
|
222
|
+
# protected CloudFront distributions forward to WAF for inspection. The
|
223
|
+
# default is 16 KB (16,384 kilobytes).
|
224
|
+
#
|
225
|
+
# <note markdown="1"> You are charged additional fees when your protected resources forward
|
226
|
+
# body sizes that are larger than the default. For more information, see
|
227
|
+
# [WAF Pricing][1].
|
228
|
+
#
|
229
|
+
# </note>
|
230
|
+
#
|
231
|
+
#
|
232
|
+
#
|
233
|
+
# [1]: http://aws.amazon.com/waf/pricing/
|
234
|
+
#
|
235
|
+
# @!attribute [rw] request_body
|
236
|
+
# Customizes the maximum size of the request body that your protected
|
237
|
+
# CloudFront distributions forward to WAF for inspection. The default
|
238
|
+
# size is 16 KB (16,384 kilobytes).
|
239
|
+
#
|
240
|
+
# <note markdown="1"> You are charged additional fees when your protected resources
|
241
|
+
# forward body sizes that are larger than the default. For more
|
242
|
+
# information, see [WAF Pricing][1].
|
243
|
+
#
|
244
|
+
# </note>
|
245
|
+
#
|
246
|
+
#
|
247
|
+
#
|
248
|
+
# [1]: http://aws.amazon.com/waf/pricing/
|
249
|
+
# @return [Hash<String,Types::RequestBodyAssociatedResourceTypeConfig>]
|
250
|
+
#
|
251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/AssociationConfig AWS API Documentation
|
252
|
+
#
|
253
|
+
class AssociationConfig < Struct.new(
|
254
|
+
:request_body)
|
255
|
+
SENSITIVE = []
|
256
|
+
include Aws::Structure
|
257
|
+
end
|
258
|
+
|
216
259
|
# Specifies that WAF should block the request and optionally defines
|
217
260
|
# additional custom handling for the response to the web request.
|
218
261
|
#
|
@@ -223,13 +266,12 @@ module Aws::WAFV2
|
|
223
266
|
# Defines a custom response for the web request.
|
224
267
|
#
|
225
268
|
# For information about customizing web requests and responses, see
|
226
|
-
# [Customizing web requests and responses in WAF][1] in the
|
227
|
-
# Developer Guide
|
269
|
+
# [Customizing web requests and responses in WAF][1] in the *WAF
|
270
|
+
# Developer Guide*.
|
228
271
|
#
|
229
272
|
#
|
230
273
|
#
|
231
274
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
|
232
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
|
233
275
|
# @return [Types::CustomResponse]
|
234
276
|
#
|
235
277
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/BlockAction AWS API Documentation
|
@@ -248,10 +290,16 @@ module Aws::WAFV2
|
|
248
290
|
#
|
249
291
|
# @!attribute [rw] oversize_handling
|
250
292
|
# What WAF should do if the body is larger than WAF can inspect. WAF
|
251
|
-
# does not support inspecting the entire contents of the
|
252
|
-
#
|
253
|
-
#
|
254
|
-
#
|
293
|
+
# does not support inspecting the entire contents of the web request
|
294
|
+
# body if the body exceeds the limit for the resource type. If the
|
295
|
+
# body is larger than the limit, the underlying host service only
|
296
|
+
# forwards the contents that are below the limit to WAF for
|
297
|
+
# inspection.
|
298
|
+
#
|
299
|
+
# The default limit is 8 KB (8,192 kilobytes) for regional resources
|
300
|
+
# and 16 KB (16,384 kilobytes) for CloudFront distributions. For
|
301
|
+
# CloudFront distributions, you can increase the limit in the web ACL
|
302
|
+
# `AssociationConfig`, for additional processing fees.
|
255
303
|
#
|
256
304
|
# The options for oversize handling are the following:
|
257
305
|
#
|
@@ -266,7 +314,7 @@ module Aws::WAFV2
|
|
266
314
|
#
|
267
315
|
# You can combine the `MATCH` or `NO_MATCH` settings for oversize
|
268
316
|
# handling with your rule and web ACL action settings, so that you
|
269
|
-
# block any request whose body is over
|
317
|
+
# block any request whose body is over the limit.
|
270
318
|
#
|
271
319
|
# Default: `CONTINUE`
|
272
320
|
# @return [String]
|
@@ -422,13 +470,12 @@ module Aws::WAFV2
|
|
422
470
|
# unexpired.
|
423
471
|
#
|
424
472
|
# For information about customizing web requests and responses, see
|
425
|
-
# [Customizing web requests and responses in WAF][1] in the
|
426
|
-
# Developer Guide
|
473
|
+
# [Customizing web requests and responses in WAF][1] in the *WAF
|
474
|
+
# Developer Guide*.
|
427
475
|
#
|
428
476
|
#
|
429
477
|
#
|
430
478
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
|
431
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
|
432
479
|
# @return [Types::CustomRequestHandling]
|
433
480
|
#
|
434
481
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CaptchaAction AWS API Documentation
|
@@ -531,13 +578,12 @@ module Aws::WAFV2
|
|
531
578
|
# unexpired.
|
532
579
|
#
|
533
580
|
# For information about customizing web requests and responses, see
|
534
|
-
# [Customizing web requests and responses in WAF][1] in the
|
535
|
-
# Developer Guide
|
581
|
+
# [Customizing web requests and responses in WAF][1] in the *WAF
|
582
|
+
# Developer Guide*.
|
536
583
|
#
|
537
584
|
#
|
538
585
|
#
|
539
586
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
|
540
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
|
541
587
|
# @return [Types::CustomRequestHandling]
|
542
588
|
#
|
543
589
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/ChallengeAction AWS API Documentation
|
@@ -596,7 +642,7 @@ module Aws::WAFV2
|
|
596
642
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
597
643
|
# for a regional application. A regional application can be an
|
598
644
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
599
|
-
# AppSync GraphQL API,
|
645
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
600
646
|
# service.
|
601
647
|
#
|
602
648
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -756,13 +802,12 @@ module Aws::WAFV2
|
|
756
802
|
# Defines custom handling for the web request.
|
757
803
|
#
|
758
804
|
# For information about customizing web requests and responses, see
|
759
|
-
# [Customizing web requests and responses in WAF][1] in the
|
760
|
-
# Developer Guide
|
805
|
+
# [Customizing web requests and responses in WAF][1] in the *WAF
|
806
|
+
# Developer Guide*.
|
761
807
|
#
|
762
808
|
#
|
763
809
|
#
|
764
810
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
|
765
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
|
766
811
|
# @return [Types::CustomRequestHandling]
|
767
812
|
#
|
768
813
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CountAction AWS API Documentation
|
@@ -782,7 +827,7 @@ module Aws::WAFV2
|
|
782
827
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
783
828
|
# for a regional application. A regional application can be an
|
784
829
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
785
|
-
# AppSync GraphQL API,
|
830
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
786
831
|
# service.
|
787
832
|
#
|
788
833
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -889,7 +934,7 @@ module Aws::WAFV2
|
|
889
934
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
890
935
|
# for a regional application. A regional application can be an
|
891
936
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
892
|
-
# AppSync GraphQL API,
|
937
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
893
938
|
# service.
|
894
939
|
#
|
895
940
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -950,7 +995,7 @@ module Aws::WAFV2
|
|
950
995
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
951
996
|
# for a regional application. A regional application can be an
|
952
997
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
953
|
-
# AppSync GraphQL API,
|
998
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
954
999
|
# service.
|
955
1000
|
#
|
956
1001
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -976,8 +1021,13 @@ module Aws::WAFV2
|
|
976
1021
|
# relative cost of each rule. Simple rules that cost little to run use
|
977
1022
|
# fewer WCUs than more complex rules that use more processing power.
|
978
1023
|
# Rule group capacity is fixed at creation, which helps users plan
|
979
|
-
# their web ACL WCU usage when they use a rule group.
|
980
|
-
#
|
1024
|
+
# their web ACL WCU usage when they use a rule group. For more
|
1025
|
+
# information, see [WAF web ACL capacity units (WCU)][1] in the *WAF
|
1026
|
+
# Developer Guide*.
|
1027
|
+
#
|
1028
|
+
#
|
1029
|
+
#
|
1030
|
+
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html
|
981
1031
|
# @return [Integer]
|
982
1032
|
#
|
983
1033
|
# @!attribute [rw] description
|
@@ -1007,18 +1057,17 @@ module Aws::WAFV2
|
|
1007
1057
|
# the rules that you define in the rule group.
|
1008
1058
|
#
|
1009
1059
|
# For information about customizing web requests and responses, see
|
1010
|
-
# [Customizing web requests and responses in WAF][1] in the
|
1011
|
-
# Developer Guide
|
1060
|
+
# [Customizing web requests and responses in WAF][1] in the *WAF
|
1061
|
+
# Developer Guide*.
|
1012
1062
|
#
|
1013
1063
|
# For information about the limits on count and size for custom
|
1014
|
-
# request and response settings, see [WAF quotas][
|
1015
|
-
# Developer Guide
|
1064
|
+
# request and response settings, see [WAF quotas][2] in the *WAF
|
1065
|
+
# Developer Guide*.
|
1016
1066
|
#
|
1017
1067
|
#
|
1018
1068
|
#
|
1019
1069
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
|
1020
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/
|
1021
|
-
# [3]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
1070
|
+
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
1022
1071
|
# @return [Hash<String,Types::CustomResponseBody>]
|
1023
1072
|
#
|
1024
1073
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CreateRuleGroupRequest AWS API Documentation
|
@@ -1061,7 +1110,7 @@ module Aws::WAFV2
|
|
1061
1110
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
1062
1111
|
# for a regional application. A regional application can be an
|
1063
1112
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
1064
|
-
# AppSync GraphQL API,
|
1113
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
1065
1114
|
# service.
|
1066
1115
|
#
|
1067
1116
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -1105,18 +1154,17 @@ module Aws::WAFV2
|
|
1105
1154
|
# rules and default actions that you define in the web ACL.
|
1106
1155
|
#
|
1107
1156
|
# For information about customizing web requests and responses, see
|
1108
|
-
# [Customizing web requests and responses in WAF][1] in the
|
1109
|
-
# Developer Guide
|
1157
|
+
# [Customizing web requests and responses in WAF][1] in the *WAF
|
1158
|
+
# Developer Guide*.
|
1110
1159
|
#
|
1111
1160
|
# For information about the limits on count and size for custom
|
1112
|
-
# request and response settings, see [WAF quotas][
|
1113
|
-
# Developer Guide
|
1161
|
+
# request and response settings, see [WAF quotas][2] in the *WAF
|
1162
|
+
# Developer Guide*.
|
1114
1163
|
#
|
1115
1164
|
#
|
1116
1165
|
#
|
1117
1166
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
|
1118
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/
|
1119
|
-
# [3]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
1167
|
+
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
1120
1168
|
# @return [Hash<String,Types::CustomResponseBody>]
|
1121
1169
|
#
|
1122
1170
|
# @!attribute [rw] captcha_config
|
@@ -1148,6 +1196,25 @@ module Aws::WAFV2
|
|
1148
1196
|
# `usa.gov` or `co.uk` as token domains.
|
1149
1197
|
# @return [Array<String>]
|
1150
1198
|
#
|
1199
|
+
# @!attribute [rw] association_config
|
1200
|
+
# Specifies custom configurations for the associations between the web
|
1201
|
+
# ACL and protected resources.
|
1202
|
+
#
|
1203
|
+
# Use this to customize the maximum size of the request body that your
|
1204
|
+
# protected CloudFront distributions forward to WAF for inspection.
|
1205
|
+
# The default is 16 KB (16,384 kilobytes).
|
1206
|
+
#
|
1207
|
+
# <note markdown="1"> You are charged additional fees when your protected resources
|
1208
|
+
# forward body sizes that are larger than the default. For more
|
1209
|
+
# information, see [WAF Pricing][1].
|
1210
|
+
#
|
1211
|
+
# </note>
|
1212
|
+
#
|
1213
|
+
#
|
1214
|
+
#
|
1215
|
+
# [1]: http://aws.amazon.com/waf/pricing/
|
1216
|
+
# @return [Types::AssociationConfig]
|
1217
|
+
#
|
1151
1218
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CreateWebACLRequest AWS API Documentation
|
1152
1219
|
#
|
1153
1220
|
class CreateWebACLRequest < Struct.new(
|
@@ -1161,7 +1228,8 @@ module Aws::WAFV2
|
|
1161
1228
|
:custom_response_bodies,
|
1162
1229
|
:captcha_config,
|
1163
1230
|
:challenge_config,
|
1164
|
-
:token_domains
|
1231
|
+
:token_domains,
|
1232
|
+
:association_config)
|
1165
1233
|
SENSITIVE = []
|
1166
1234
|
include Aws::Structure
|
1167
1235
|
end
|
@@ -1213,26 +1281,24 @@ module Aws::WAFV2
|
|
1213
1281
|
# `CaptchaAction` for requests with valid t okens, and `AllowAction`.
|
1214
1282
|
#
|
1215
1283
|
# For information about customizing web requests and responses, see
|
1216
|
-
# [Customizing web requests and responses in WAF][1] in the
|
1217
|
-
# Developer Guide
|
1284
|
+
# [Customizing web requests and responses in WAF][1] in the *WAF
|
1285
|
+
# Developer Guide*.
|
1218
1286
|
#
|
1219
1287
|
#
|
1220
1288
|
#
|
1221
1289
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
|
1222
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
|
1223
1290
|
#
|
1224
1291
|
# @!attribute [rw] insert_headers
|
1225
1292
|
# The HTTP headers to insert into the request. Duplicate header names
|
1226
1293
|
# are not allowed.
|
1227
1294
|
#
|
1228
1295
|
# For information about the limits on count and size for custom
|
1229
|
-
# request and response settings, see [WAF quotas][1] in the
|
1230
|
-
# Developer Guide
|
1296
|
+
# request and response settings, see [WAF quotas][1] in the *WAF
|
1297
|
+
# Developer Guide*.
|
1231
1298
|
#
|
1232
1299
|
#
|
1233
1300
|
#
|
1234
1301
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
1235
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
|
1236
1302
|
# @return [Array<Types::CustomHTTPHeader>]
|
1237
1303
|
#
|
1238
1304
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CustomRequestHandling AWS API Documentation
|
@@ -1248,25 +1314,23 @@ module Aws::WAFV2
|
|
1248
1314
|
# BlockAction.
|
1249
1315
|
#
|
1250
1316
|
# For information about customizing web requests and responses, see
|
1251
|
-
# [Customizing web requests and responses in WAF][1] in the
|
1252
|
-
# Developer Guide
|
1317
|
+
# [Customizing web requests and responses in WAF][1] in the *WAF
|
1318
|
+
# Developer Guide*.
|
1253
1319
|
#
|
1254
1320
|
#
|
1255
1321
|
#
|
1256
1322
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
|
1257
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
|
1258
1323
|
#
|
1259
1324
|
# @!attribute [rw] response_code
|
1260
1325
|
# The HTTP status code to return to the client.
|
1261
1326
|
#
|
1262
1327
|
# For a list of status codes that you can use in your custom
|
1263
1328
|
# responses, see [Supported status codes for custom response][1] in
|
1264
|
-
# the
|
1329
|
+
# the *WAF Developer Guide*.
|
1265
1330
|
#
|
1266
1331
|
#
|
1267
1332
|
#
|
1268
1333
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html
|
1269
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
|
1270
1334
|
# @return [Integer]
|
1271
1335
|
#
|
1272
1336
|
# @!attribute [rw] custom_response_body_key
|
@@ -1285,13 +1349,12 @@ module Aws::WAFV2
|
|
1285
1349
|
# not allowed.
|
1286
1350
|
#
|
1287
1351
|
# For information about the limits on count and size for custom
|
1288
|
-
# request and response settings, see [WAF quotas][1] in the
|
1289
|
-
# Developer Guide
|
1352
|
+
# request and response settings, see [WAF quotas][1] in the *WAF
|
1353
|
+
# Developer Guide*.
|
1290
1354
|
#
|
1291
1355
|
#
|
1292
1356
|
#
|
1293
1357
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
1294
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
|
1295
1358
|
# @return [Array<Types::CustomHTTPHeader>]
|
1296
1359
|
#
|
1297
1360
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CustomResponse AWS API Documentation
|
@@ -1319,13 +1382,12 @@ module Aws::WAFV2
|
|
1319
1382
|
# must specify JSON content in the `ContentType` setting.
|
1320
1383
|
#
|
1321
1384
|
# For information about the limits on count and size for custom
|
1322
|
-
# request and response settings, see [WAF quotas][1] in the
|
1323
|
-
# Developer Guide
|
1385
|
+
# request and response settings, see [WAF quotas][1] in the *WAF
|
1386
|
+
# Developer Guide*.
|
1324
1387
|
#
|
1325
1388
|
#
|
1326
1389
|
#
|
1327
1390
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
1328
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
|
1329
1391
|
# @return [String]
|
1330
1392
|
#
|
1331
1393
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/CustomResponseBody AWS API Documentation
|
@@ -1412,7 +1474,7 @@ module Aws::WAFV2
|
|
1412
1474
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
1413
1475
|
# for a regional application. A regional application can be an
|
1414
1476
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
1415
|
-
# AppSync GraphQL API,
|
1477
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
1416
1478
|
# service.
|
1417
1479
|
#
|
1418
1480
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -1502,7 +1564,7 @@ module Aws::WAFV2
|
|
1502
1564
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
1503
1565
|
# for a regional application. A regional application can be an
|
1504
1566
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
1505
|
-
# AppSync GraphQL API,
|
1567
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
1506
1568
|
# service.
|
1507
1569
|
#
|
1508
1570
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -1556,7 +1618,7 @@ module Aws::WAFV2
|
|
1556
1618
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
1557
1619
|
# for a regional application. A regional application can be an
|
1558
1620
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
1559
|
-
# AppSync GraphQL API,
|
1621
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
1560
1622
|
# service.
|
1561
1623
|
#
|
1562
1624
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -1610,7 +1672,7 @@ module Aws::WAFV2
|
|
1610
1672
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
1611
1673
|
# for a regional application. A regional application can be an
|
1612
1674
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
1613
|
-
# AppSync GraphQL API,
|
1675
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
1614
1676
|
# service.
|
1615
1677
|
#
|
1616
1678
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -1669,7 +1731,7 @@ module Aws::WAFV2
|
|
1669
1731
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
1670
1732
|
# for a regional application. A regional application can be an
|
1671
1733
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
1672
|
-
# AppSync GraphQL API,
|
1734
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
1673
1735
|
# service.
|
1674
1736
|
#
|
1675
1737
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -1716,13 +1778,21 @@ module Aws::WAFV2
|
|
1716
1778
|
# @return [String]
|
1717
1779
|
#
|
1718
1780
|
# @!attribute [rw] capacity
|
1719
|
-
# The web ACL capacity units (WCUs) required for this rule group.
|
1720
|
-
#
|
1721
|
-
#
|
1722
|
-
#
|
1723
|
-
#
|
1724
|
-
#
|
1725
|
-
#
|
1781
|
+
# The web ACL capacity units (WCUs) required for this rule group.
|
1782
|
+
#
|
1783
|
+
# WAF uses WCUs to calculate and control the operating resources that
|
1784
|
+
# are used to run your rules, rule groups, and web ACLs. WAF
|
1785
|
+
# calculates capacity differently for each rule type, to reflect the
|
1786
|
+
# relative cost of each rule. Simple rules that cost little to run use
|
1787
|
+
# fewer WCUs than more complex rules that use more processing power.
|
1788
|
+
# Rule group capacity is fixed at creation, which helps users plan
|
1789
|
+
# their web ACL WCU usage when they use a rule group. For more
|
1790
|
+
# information, see [WAF web ACL capacity units (WCU)][1] in the *WAF
|
1791
|
+
# Developer Guide*.
|
1792
|
+
#
|
1793
|
+
#
|
1794
|
+
#
|
1795
|
+
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html
|
1726
1796
|
# @return [Integer]
|
1727
1797
|
#
|
1728
1798
|
# @!attribute [rw] rules
|
@@ -1779,20 +1849,22 @@ module Aws::WAFV2
|
|
1779
1849
|
# The ARN must be in one of the following formats:
|
1780
1850
|
#
|
1781
1851
|
# * For an Application Load Balancer:
|
1782
|
-
# `arn:
|
1852
|
+
# `arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
|
1783
1853
|
# `
|
1784
1854
|
#
|
1785
1855
|
# * For an Amazon API Gateway REST API:
|
1786
|
-
# `arn:
|
1856
|
+
# `arn:partition:apigateway:region::/restapis/api-id/stages/stage-name
|
1857
|
+
# `
|
1787
1858
|
#
|
1788
1859
|
# * For an AppSync GraphQL API:
|
1789
|
-
# `arn:
|
1860
|
+
# `arn:partition:appsync:region:account-id:apis/GraphQLApiId `
|
1790
1861
|
#
|
1791
1862
|
# * For an Amazon Cognito user pool:
|
1792
|
-
# `arn:
|
1863
|
+
# `arn:partition:cognito-idp:region:account-id:userpool/user-pool-id
|
1864
|
+
# `
|
1793
1865
|
#
|
1794
1866
|
# * For an App Runner service:
|
1795
|
-
# `arn:
|
1867
|
+
# `arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id
|
1796
1868
|
# `
|
1797
1869
|
# @return [String]
|
1798
1870
|
#
|
@@ -1882,10 +1954,15 @@ module Aws::WAFV2
|
|
1882
1954
|
# contains any additional data that you want to send to your web
|
1883
1955
|
# server as the HTTP request body, such as data from a form.
|
1884
1956
|
#
|
1885
|
-
#
|
1886
|
-
#
|
1887
|
-
#
|
1888
|
-
#
|
1957
|
+
# A limited amount of the request body is forwarded to WAF for
|
1958
|
+
# inspection by the underlying host service. For regional resources,
|
1959
|
+
# the limit is 8 KB (8,192 kilobytes) and for CloudFront
|
1960
|
+
# distributions, the limit is 16 KB (16,384 kilobytes). For CloudFront
|
1961
|
+
# distributions, you can increase the limit in the web ACL's
|
1962
|
+
# `AssociationConfig`, for additional processing fees.
|
1963
|
+
#
|
1964
|
+
# For information about how to handle oversized request bodies, see
|
1965
|
+
# the `Body` object configuration.
|
1889
1966
|
# @return [Types::Body]
|
1890
1967
|
#
|
1891
1968
|
# @!attribute [rw] method
|
@@ -1899,10 +1976,15 @@ module Aws::WAFV2
|
|
1899
1976
|
# contains any additional data that you want to send to your web
|
1900
1977
|
# server as the HTTP request body, such as data from a form.
|
1901
1978
|
#
|
1902
|
-
#
|
1903
|
-
#
|
1904
|
-
#
|
1905
|
-
#
|
1979
|
+
# A limited amount of the request body is forwarded to WAF for
|
1980
|
+
# inspection by the underlying host service. For regional resources,
|
1981
|
+
# the limit is 8 KB (8,192 kilobytes) and for CloudFront
|
1982
|
+
# distributions, the limit is 16 KB (16,384 kilobytes). For CloudFront
|
1983
|
+
# distributions, you can increase the limit in the web ACL's
|
1984
|
+
# `AssociationConfig`, for additional processing fees.
|
1985
|
+
#
|
1986
|
+
# For information about how to handle oversized request bodies, see
|
1987
|
+
# the `JsonBody` object configuration.
|
1906
1988
|
# @return [Types::JsonBody]
|
1907
1989
|
#
|
1908
1990
|
# @!attribute [rw] headers
|
@@ -2033,40 +2115,19 @@ module Aws::WAFV2
|
|
2033
2115
|
end
|
2034
2116
|
|
2035
2117
|
# The processing guidance for an Firewall Manager rule. This is like a
|
2036
|
-
# regular rule Statement, but it can only contain a rule group
|
2118
|
+
# regular rule Statement, but it can only contain a single rule group
|
2037
2119
|
# reference.
|
2038
2120
|
#
|
2039
2121
|
# @!attribute [rw] managed_rule_group_statement
|
2040
|
-
# A
|
2041
|
-
#
|
2042
|
-
#
|
2043
|
-
# calling ListAvailableManagedRuleGroups.
|
2044
|
-
#
|
2045
|
-
# You cannot nest a `ManagedRuleGroupStatement`, for example for use
|
2046
|
-
# inside a `NotStatement` or `OrStatement`. It can only be referenced
|
2047
|
-
# as a top-level statement within a rule.
|
2048
|
-
#
|
2049
|
-
# <note markdown="1"> You are charged additional fees when you use the WAF Bot Control
|
2050
|
-
# managed rule group `AWSManagedRulesBotControlRuleSet` or the WAF
|
2051
|
-
# Fraud Control account takeover prevention (ATP) managed rule group
|
2052
|
-
# `AWSManagedRulesATPRuleSet`. For more information, see [WAF
|
2053
|
-
# Pricing][1].
|
2054
|
-
#
|
2055
|
-
# </note>
|
2056
|
-
#
|
2057
|
-
#
|
2058
|
-
#
|
2059
|
-
# [1]: http://aws.amazon.com/waf/pricing/
|
2122
|
+
# A statement used by Firewall Manager to run the rules that are
|
2123
|
+
# defined in a managed rule group. This is managed by Firewall Manager
|
2124
|
+
# for an Firewall Manager WAF policy.
|
2060
2125
|
# @return [Types::ManagedRuleGroupStatement]
|
2061
2126
|
#
|
2062
2127
|
# @!attribute [rw] rule_group_reference_statement
|
2063
|
-
# A
|
2064
|
-
#
|
2065
|
-
#
|
2066
|
-
#
|
2067
|
-
# You cannot nest a `RuleGroupReferenceStatement`, for example for use
|
2068
|
-
# inside a `NotStatement` or `OrStatement`. You can only use a rule
|
2069
|
-
# group reference statement at the top level inside a web ACL.
|
2128
|
+
# A statement used by Firewall Manager to run the rules that are
|
2129
|
+
# defined in a rule group. This is managed by Firewall Manager for an
|
2130
|
+
# Firewall Manager WAF policy.
|
2070
2131
|
# @return [Types::RuleGroupReferenceStatement]
|
2071
2132
|
#
|
2072
2133
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/FirewallManagerStatement AWS API Documentation
|
@@ -2243,7 +2304,7 @@ module Aws::WAFV2
|
|
2243
2304
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
2244
2305
|
# for a regional application. A regional application can be an
|
2245
2306
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
2246
|
-
# AppSync GraphQL API,
|
2307
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
2247
2308
|
# service.
|
2248
2309
|
#
|
2249
2310
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -2332,7 +2393,7 @@ module Aws::WAFV2
|
|
2332
2393
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
2333
2394
|
# for a regional application. A regional application can be an
|
2334
2395
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
2335
|
-
# AppSync GraphQL API,
|
2396
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
2336
2397
|
# service.
|
2337
2398
|
#
|
2338
2399
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -2445,7 +2506,7 @@ module Aws::WAFV2
|
|
2445
2506
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
2446
2507
|
# for a regional application. A regional application can be an
|
2447
2508
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
2448
|
-
# AppSync GraphQL API,
|
2509
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
2449
2510
|
# service.
|
2450
2511
|
#
|
2451
2512
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -2519,7 +2580,7 @@ module Aws::WAFV2
|
|
2519
2580
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
2520
2581
|
# for a regional application. A regional application can be an
|
2521
2582
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
2522
|
-
# AppSync GraphQL API,
|
2583
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
2523
2584
|
# service.
|
2524
2585
|
#
|
2525
2586
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -2580,7 +2641,7 @@ module Aws::WAFV2
|
|
2580
2641
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
2581
2642
|
# for a regional application. A regional application can be an
|
2582
2643
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
2583
|
-
# AppSync GraphQL API,
|
2644
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
2584
2645
|
# service.
|
2585
2646
|
#
|
2586
2647
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -2651,7 +2712,7 @@ module Aws::WAFV2
|
|
2651
2712
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
2652
2713
|
# for a regional application. A regional application can be an
|
2653
2714
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
2654
|
-
# AppSync GraphQL API,
|
2715
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
2655
2716
|
# service.
|
2656
2717
|
#
|
2657
2718
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -2731,20 +2792,22 @@ module Aws::WAFV2
|
|
2731
2792
|
# The ARN must be in one of the following formats:
|
2732
2793
|
#
|
2733
2794
|
# * For an Application Load Balancer:
|
2734
|
-
# `arn:
|
2795
|
+
# `arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
|
2735
2796
|
# `
|
2736
2797
|
#
|
2737
2798
|
# * For an Amazon API Gateway REST API:
|
2738
|
-
# `arn:
|
2799
|
+
# `arn:partition:apigateway:region::/restapis/api-id/stages/stage-name
|
2800
|
+
# `
|
2739
2801
|
#
|
2740
2802
|
# * For an AppSync GraphQL API:
|
2741
|
-
# `arn:
|
2803
|
+
# `arn:partition:appsync:region:account-id:apis/GraphQLApiId `
|
2742
2804
|
#
|
2743
2805
|
# * For an Amazon Cognito user pool:
|
2744
|
-
# `arn:
|
2806
|
+
# `arn:partition:cognito-idp:region:account-id:userpool/user-pool-id
|
2807
|
+
# `
|
2745
2808
|
#
|
2746
2809
|
# * For an App Runner service:
|
2747
|
-
# `arn:
|
2810
|
+
# `arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id
|
2748
2811
|
# `
|
2749
2812
|
# @return [String]
|
2750
2813
|
#
|
@@ -2778,7 +2841,7 @@ module Aws::WAFV2
|
|
2778
2841
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
2779
2842
|
# for a regional application. A regional application can be an
|
2780
2843
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
2781
|
-
# AppSync GraphQL API,
|
2844
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
2782
2845
|
# service.
|
2783
2846
|
#
|
2784
2847
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -3347,10 +3410,16 @@ module Aws::WAFV2
|
|
3347
3410
|
#
|
3348
3411
|
# @!attribute [rw] oversize_handling
|
3349
3412
|
# What WAF should do if the body is larger than WAF can inspect. WAF
|
3350
|
-
# does not support inspecting the entire contents of the
|
3351
|
-
#
|
3352
|
-
#
|
3353
|
-
#
|
3413
|
+
# does not support inspecting the entire contents of the web request
|
3414
|
+
# body if the body exceeds the limit for the resource type. If the
|
3415
|
+
# body is larger than the limit, the underlying host service only
|
3416
|
+
# forwards the contents that are below the limit to WAF for
|
3417
|
+
# inspection.
|
3418
|
+
#
|
3419
|
+
# The default limit is 8 KB (8,192 kilobytes) for regional resources
|
3420
|
+
# and 16 KB (16,384 kilobytes) for CloudFront distributions. For
|
3421
|
+
# CloudFront distributions, you can increase the limit in the web ACL
|
3422
|
+
# `AssociationConfig`, for additional processing fees.
|
3354
3423
|
#
|
3355
3424
|
# The options for oversize handling are the following:
|
3356
3425
|
#
|
@@ -3365,7 +3434,7 @@ module Aws::WAFV2
|
|
3365
3434
|
#
|
3366
3435
|
# You can combine the `MATCH` or `NO_MATCH` settings for oversize
|
3367
3436
|
# handling with your rule and web ACL action settings, so that you
|
3368
|
-
# block any request whose body is over
|
3437
|
+
# block any request whose body is over the limit.
|
3369
3438
|
#
|
3370
3439
|
# Default: `CONTINUE`
|
3371
3440
|
# @return [String]
|
@@ -3537,7 +3606,7 @@ module Aws::WAFV2
|
|
3537
3606
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
3538
3607
|
# for a regional application. A regional application can be an
|
3539
3608
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
3540
|
-
# AppSync GraphQL API,
|
3609
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
3541
3610
|
# service.
|
3542
3611
|
#
|
3543
3612
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -3607,7 +3676,7 @@ module Aws::WAFV2
|
|
3607
3676
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
3608
3677
|
# for a regional application. A regional application can be an
|
3609
3678
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
3610
|
-
# AppSync GraphQL API,
|
3679
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
3611
3680
|
# service.
|
3612
3681
|
#
|
3613
3682
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -3668,7 +3737,7 @@ module Aws::WAFV2
|
|
3668
3737
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
3669
3738
|
# for a regional application. A regional application can be an
|
3670
3739
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
3671
|
-
# AppSync GraphQL API,
|
3740
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
3672
3741
|
# service.
|
3673
3742
|
#
|
3674
3743
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -3731,7 +3800,7 @@ module Aws::WAFV2
|
|
3731
3800
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
3732
3801
|
# for a regional application. A regional application can be an
|
3733
3802
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
3734
|
-
# AppSync GraphQL API,
|
3803
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
3735
3804
|
# service.
|
3736
3805
|
#
|
3737
3806
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -3792,7 +3861,7 @@ module Aws::WAFV2
|
|
3792
3861
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
3793
3862
|
# for a regional application. A regional application can be an
|
3794
3863
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
3795
|
-
# AppSync GraphQL API,
|
3864
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
3796
3865
|
# service.
|
3797
3866
|
#
|
3798
3867
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -3904,7 +3973,7 @@ module Aws::WAFV2
|
|
3904
3973
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
3905
3974
|
# for a regional application. A regional application can be an
|
3906
3975
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
3907
|
-
# AppSync GraphQL API,
|
3976
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
3908
3977
|
# service.
|
3909
3978
|
#
|
3910
3979
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -3968,7 +4037,7 @@ module Aws::WAFV2
|
|
3968
4037
|
# @!attribute [rw] resource_type
|
3969
4038
|
# Used for web ACLs that are scoped for regional applications. A
|
3970
4039
|
# regional application can be an Application Load Balancer (ALB), an
|
3971
|
-
# Amazon API Gateway REST API, an AppSync GraphQL API,
|
4040
|
+
# Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon
|
3972
4041
|
# Cognito user pool, or an App Runner service.
|
3973
4042
|
#
|
3974
4043
|
# <note markdown="1"> If you don't provide a resource type, the call uses the resource
|
@@ -4005,7 +4074,7 @@ module Aws::WAFV2
|
|
4005
4074
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
4006
4075
|
# for a regional application. A regional application can be an
|
4007
4076
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
4008
|
-
# AppSync GraphQL API,
|
4077
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
4009
4078
|
# service.
|
4010
4079
|
#
|
4011
4080
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -4116,7 +4185,7 @@ module Aws::WAFV2
|
|
4116
4185
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
4117
4186
|
# for a regional application. A regional application can be an
|
4118
4187
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
4119
|
-
# AppSync GraphQL API,
|
4188
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
4120
4189
|
# service.
|
4121
4190
|
#
|
4122
4191
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -4721,8 +4790,13 @@ module Aws::WAFV2
|
|
4721
4790
|
# relative cost of each rule. Simple rules that cost little to run use
|
4722
4791
|
# fewer WCUs than more complex rules that use more processing power.
|
4723
4792
|
# Rule group capacity is fixed at creation, which helps users plan
|
4724
|
-
# their web ACL WCU usage when they use a rule group.
|
4725
|
-
#
|
4793
|
+
# their web ACL WCU usage when they use a rule group. For more
|
4794
|
+
# information, see [WAF web ACL capacity units (WCU)][1] in the *WAF
|
4795
|
+
# Developer Guide*.
|
4796
|
+
#
|
4797
|
+
#
|
4798
|
+
#
|
4799
|
+
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html
|
4726
4800
|
# @return [Integer]
|
4727
4801
|
#
|
4728
4802
|
# @!attribute [rw] forecasted_lifetime
|
@@ -4960,7 +5034,7 @@ module Aws::WAFV2
|
|
4960
5034
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
4961
5035
|
# for a regional application. A regional application can be an
|
4962
5036
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
4963
|
-
# AppSync GraphQL API,
|
5037
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
4964
5038
|
# service.
|
4965
5039
|
#
|
4966
5040
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -5043,8 +5117,7 @@ module Aws::WAFV2
|
|
5043
5117
|
#
|
5044
5118
|
# The policy specifications must conform to the following:
|
5045
5119
|
#
|
5046
|
-
# * The policy must be composed using IAM Policy version 2012-10-17
|
5047
|
-
# version 2015-01-01.
|
5120
|
+
# * The policy must be composed using IAM Policy version 2012-10-17.
|
5048
5121
|
#
|
5049
5122
|
# * The policy must include specifications for `Effect`, `Action`, and
|
5050
5123
|
# `Principal`.
|
@@ -5399,6 +5472,39 @@ module Aws::WAFV2
|
|
5399
5472
|
include Aws::Structure
|
5400
5473
|
end
|
5401
5474
|
|
5475
|
+
# Customizes the maximum size of the request body that your protected
|
5476
|
+
# CloudFront distributions forward to WAF for inspection. The default
|
5477
|
+
# size is 16 KB (16,384 kilobytes).
|
5478
|
+
#
|
5479
|
+
# <note markdown="1"> You are charged additional fees when your protected resources forward
|
5480
|
+
# body sizes that are larger than the default. For more information, see
|
5481
|
+
# [WAF Pricing][1].
|
5482
|
+
#
|
5483
|
+
# </note>
|
5484
|
+
#
|
5485
|
+
# This is used in the `AssociationConfig` of the web ACL.
|
5486
|
+
#
|
5487
|
+
#
|
5488
|
+
#
|
5489
|
+
# [1]: http://aws.amazon.com/waf/pricing/
|
5490
|
+
#
|
5491
|
+
# @!attribute [rw] default_size_inspection_limit
|
5492
|
+
# Specifies the maximum size of the web request body component that an
|
5493
|
+
# associated CloudFront distribution should send to WAF for
|
5494
|
+
# inspection. This applies to statements in the web ACL that inspect
|
5495
|
+
# the body or JSON body.
|
5496
|
+
#
|
5497
|
+
# Default: `16 KB (16,384 kilobytes)`
|
5498
|
+
# @return [String]
|
5499
|
+
#
|
5500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/RequestBodyAssociatedResourceTypeConfig AWS API Documentation
|
5501
|
+
#
|
5502
|
+
class RequestBodyAssociatedResourceTypeConfig < Struct.new(
|
5503
|
+
:default_size_inspection_limit)
|
5504
|
+
SENSITIVE = []
|
5505
|
+
include Aws::Structure
|
5506
|
+
end
|
5507
|
+
|
5402
5508
|
# The criteria for inspecting login requests, used by the ATP rule group
|
5403
5509
|
# to validate credentials usage.
|
5404
5510
|
#
|
@@ -5905,8 +6011,13 @@ module Aws::WAFV2
|
|
5905
6011
|
# relative cost of each rule. Simple rules that cost little to run use
|
5906
6012
|
# fewer WCUs than more complex rules that use more processing power.
|
5907
6013
|
# Rule group capacity is fixed at creation, which helps users plan
|
5908
|
-
# their web ACL WCU usage when they use a rule group.
|
5909
|
-
#
|
6014
|
+
# their web ACL WCU usage when they use a rule group. For more
|
6015
|
+
# information, see [WAF web ACL capacity units (WCU)][1] in the *WAF
|
6016
|
+
# Developer Guide*.
|
6017
|
+
#
|
6018
|
+
#
|
6019
|
+
#
|
6020
|
+
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html
|
5910
6021
|
# @return [Integer]
|
5911
6022
|
#
|
5912
6023
|
# @!attribute [rw] arn
|
@@ -5953,18 +6064,17 @@ module Aws::WAFV2
|
|
5953
6064
|
# the rules that you define in the rule group.
|
5954
6065
|
#
|
5955
6066
|
# For information about customizing web requests and responses, see
|
5956
|
-
# [Customizing web requests and responses in WAF][1] in the
|
5957
|
-
# Developer Guide
|
6067
|
+
# [Customizing web requests and responses in WAF][1] in the *WAF
|
6068
|
+
# Developer Guide*.
|
5958
6069
|
#
|
5959
6070
|
# For information about the limits on count and size for custom
|
5960
|
-
# request and response settings, see [WAF quotas][
|
5961
|
-
# Developer Guide
|
6071
|
+
# request and response settings, see [WAF quotas][2] in the *WAF
|
6072
|
+
# Developer Guide*.
|
5962
6073
|
#
|
5963
6074
|
#
|
5964
6075
|
#
|
5965
6076
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
|
5966
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/
|
5967
|
-
# [3]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
6077
|
+
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
5968
6078
|
# @return [Hash<String,Types::CustomResponseBody>]
|
5969
6079
|
#
|
5970
6080
|
# @!attribute [rw] available_labels
|
@@ -6251,9 +6361,14 @@ module Aws::WAFV2
|
|
6251
6361
|
# statement to look for query strings that are longer than 100 bytes.
|
6252
6362
|
#
|
6253
6363
|
# If you configure WAF to inspect the request body, WAF inspects only
|
6254
|
-
# the
|
6255
|
-
#
|
6256
|
-
#
|
6364
|
+
# the number of bytes of the body up to the limit for the web ACL. By
|
6365
|
+
# default, for regional web ACLs, this limit is 8 KB (8,192 kilobytes)
|
6366
|
+
# and for CloudFront web ACLs, this limit is 16 KB (16,384 kilobytes).
|
6367
|
+
# For CloudFront web ACLs, you can increase the limit in the web ACL
|
6368
|
+
# `AssociationConfig`, for additional fees. If you know that the request
|
6369
|
+
# body for your web requests should never exceed the inspection limit,
|
6370
|
+
# you could use a size constraint statement to block requests that have
|
6371
|
+
# a larger request body size.
|
6257
6372
|
#
|
6258
6373
|
# If you choose URI for the value of Part of the request to filter on,
|
6259
6374
|
# the slash (/) in the URI counts as one character. For example, the URI
|
@@ -6375,10 +6490,14 @@ module Aws::WAFV2
|
|
6375
6490
|
# 100 bytes.
|
6376
6491
|
#
|
6377
6492
|
# If you configure WAF to inspect the request body, WAF inspects only
|
6378
|
-
# the
|
6379
|
-
#
|
6380
|
-
#
|
6381
|
-
#
|
6493
|
+
# the number of bytes of the body up to the limit for the web ACL. By
|
6494
|
+
# default, for regional web ACLs, this limit is 8 KB (8,192 kilobytes)
|
6495
|
+
# and for CloudFront web ACLs, this limit is 16 KB (16,384 kilobytes).
|
6496
|
+
# For CloudFront web ACLs, you can increase the limit in the web ACL
|
6497
|
+
# `AssociationConfig`, for additional fees. If you know that the
|
6498
|
+
# request body for your web requests should never exceed the
|
6499
|
+
# inspection limit, you could use a size constraint statement to block
|
6500
|
+
# requests that have a larger request body size.
|
6382
6501
|
#
|
6383
6502
|
# If you choose URI for the value of Part of the request to filter on,
|
6384
6503
|
# the slash (/) in the URI counts as one character. For example, the
|
@@ -6893,7 +7012,7 @@ module Aws::WAFV2
|
|
6893
7012
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
6894
7013
|
# for a regional application. A regional application can be an
|
6895
7014
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
6896
|
-
# AppSync GraphQL API,
|
7015
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
6897
7016
|
# service.
|
6898
7017
|
#
|
6899
7018
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -7012,7 +7131,7 @@ module Aws::WAFV2
|
|
7012
7131
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
7013
7132
|
# for a regional application. A regional application can be an
|
7014
7133
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
7015
|
-
# AppSync GraphQL API,
|
7134
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
7016
7135
|
# service.
|
7017
7136
|
#
|
7018
7137
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -7111,7 +7230,7 @@ module Aws::WAFV2
|
|
7111
7230
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
7112
7231
|
# for a regional application. A regional application can be an
|
7113
7232
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
7114
|
-
# AppSync GraphQL API,
|
7233
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
7115
7234
|
# service.
|
7116
7235
|
#
|
7117
7236
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -7184,7 +7303,7 @@ module Aws::WAFV2
|
|
7184
7303
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
7185
7304
|
# for a regional application. A regional application can be an
|
7186
7305
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
7187
|
-
# AppSync GraphQL API,
|
7306
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
7188
7307
|
# service.
|
7189
7308
|
#
|
7190
7309
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -7237,18 +7356,17 @@ module Aws::WAFV2
|
|
7237
7356
|
# the rules that you define in the rule group.
|
7238
7357
|
#
|
7239
7358
|
# For information about customizing web requests and responses, see
|
7240
|
-
# [Customizing web requests and responses in WAF][1] in the
|
7241
|
-
# Developer Guide
|
7359
|
+
# [Customizing web requests and responses in WAF][1] in the *WAF
|
7360
|
+
# Developer Guide*.
|
7242
7361
|
#
|
7243
7362
|
# For information about the limits on count and size for custom
|
7244
|
-
# request and response settings, see [WAF quotas][
|
7245
|
-
# Developer Guide
|
7363
|
+
# request and response settings, see [WAF quotas][2] in the *WAF
|
7364
|
+
# Developer Guide*.
|
7246
7365
|
#
|
7247
7366
|
#
|
7248
7367
|
#
|
7249
7368
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
|
7250
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/
|
7251
|
-
# [3]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
7369
|
+
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
7252
7370
|
# @return [Hash<String,Types::CustomResponseBody>]
|
7253
7371
|
#
|
7254
7372
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/UpdateRuleGroupRequest AWS API Documentation
|
@@ -7289,7 +7407,7 @@ module Aws::WAFV2
|
|
7289
7407
|
# Specifies whether this is for an Amazon CloudFront distribution or
|
7290
7408
|
# for a regional application. A regional application can be an
|
7291
7409
|
# Application Load Balancer (ALB), an Amazon API Gateway REST API, an
|
7292
|
-
# AppSync GraphQL API,
|
7410
|
+
# AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner
|
7293
7411
|
# service.
|
7294
7412
|
#
|
7295
7413
|
# To work with CloudFront, you must also specify the Region US East
|
@@ -7347,18 +7465,17 @@ module Aws::WAFV2
|
|
7347
7465
|
# rules and default actions that you define in the web ACL.
|
7348
7466
|
#
|
7349
7467
|
# For information about customizing web requests and responses, see
|
7350
|
-
# [Customizing web requests and responses in WAF][1] in the
|
7351
|
-
# Developer Guide
|
7468
|
+
# [Customizing web requests and responses in WAF][1] in the *WAF
|
7469
|
+
# Developer Guide*.
|
7352
7470
|
#
|
7353
7471
|
# For information about the limits on count and size for custom
|
7354
|
-
# request and response settings, see [WAF quotas][
|
7355
|
-
# Developer Guide
|
7472
|
+
# request and response settings, see [WAF quotas][2] in the *WAF
|
7473
|
+
# Developer Guide*.
|
7356
7474
|
#
|
7357
7475
|
#
|
7358
7476
|
#
|
7359
7477
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
|
7360
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/
|
7361
|
-
# [3]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
7478
|
+
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
7362
7479
|
# @return [Hash<String,Types::CustomResponseBody>]
|
7363
7480
|
#
|
7364
7481
|
# @!attribute [rw] captcha_config
|
@@ -7390,6 +7507,25 @@ module Aws::WAFV2
|
|
7390
7507
|
# `usa.gov` or `co.uk` as token domains.
|
7391
7508
|
# @return [Array<String>]
|
7392
7509
|
#
|
7510
|
+
# @!attribute [rw] association_config
|
7511
|
+
# Specifies custom configurations for the associations between the web
|
7512
|
+
# ACL and protected resources.
|
7513
|
+
#
|
7514
|
+
# Use this to customize the maximum size of the request body that your
|
7515
|
+
# protected CloudFront distributions forward to WAF for inspection.
|
7516
|
+
# The default is 16 KB (16,384 kilobytes).
|
7517
|
+
#
|
7518
|
+
# <note markdown="1"> You are charged additional fees when your protected resources
|
7519
|
+
# forward body sizes that are larger than the default. For more
|
7520
|
+
# information, see [WAF Pricing][1].
|
7521
|
+
#
|
7522
|
+
# </note>
|
7523
|
+
#
|
7524
|
+
#
|
7525
|
+
#
|
7526
|
+
# [1]: http://aws.amazon.com/waf/pricing/
|
7527
|
+
# @return [Types::AssociationConfig]
|
7528
|
+
#
|
7393
7529
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/UpdateWebACLRequest AWS API Documentation
|
7394
7530
|
#
|
7395
7531
|
class UpdateWebACLRequest < Struct.new(
|
@@ -7404,7 +7540,8 @@ module Aws::WAFV2
|
|
7404
7540
|
:custom_response_bodies,
|
7405
7541
|
:captcha_config,
|
7406
7542
|
:challenge_config,
|
7407
|
-
:token_domains
|
7543
|
+
:token_domains,
|
7544
|
+
:association_config)
|
7408
7545
|
SENSITIVE = []
|
7409
7546
|
include Aws::Structure
|
7410
7547
|
end
|
@@ -7499,7 +7636,7 @@ module Aws::WAFV2
|
|
7499
7636
|
# @!attribute [rw] cloud_watch_metrics_enabled
|
7500
7637
|
# A boolean indicating whether the associated resource sends metrics
|
7501
7638
|
# to Amazon CloudWatch. For the list of available metrics, see [WAF
|
7502
|
-
# Metrics][1]
|
7639
|
+
# Metrics][1] in the *WAF Developer Guide*.
|
7503
7640
|
#
|
7504
7641
|
#
|
7505
7642
|
#
|
@@ -7665,8 +7802,7 @@ module Aws::WAFV2
|
|
7665
7802
|
#
|
7666
7803
|
# The policy specifications must conform to the following:
|
7667
7804
|
#
|
7668
|
-
# * The policy must be composed using IAM Policy version 2012-10-17
|
7669
|
-
# version 2015-01-01.
|
7805
|
+
# * The policy must be composed using IAM Policy version 2012-10-17.
|
7670
7806
|
#
|
7671
7807
|
# * The policy must include specifications for `Effect`, `Action`, and
|
7672
7808
|
# `Principal`.
|
@@ -7871,7 +8007,7 @@ module Aws::WAFV2
|
|
7871
8007
|
# can associate a web ACL with one or more Amazon Web Services resources
|
7872
8008
|
# to protect. The resources can be an Amazon CloudFront distribution, an
|
7873
8009
|
# Amazon API Gateway REST API, an Application Load Balancer, an AppSync
|
7874
|
-
# GraphQL API, Amazon Cognito user pool, or an App Runner service.
|
8010
|
+
# GraphQL API, an Amazon Cognito user pool, or an App Runner service.
|
7875
8011
|
#
|
7876
8012
|
# @!attribute [rw] name
|
7877
8013
|
# The name of the web ACL. You cannot change the name of a web ACL
|
@@ -7920,8 +8056,13 @@ module Aws::WAFV2
|
|
7920
8056
|
# relative cost of each rule. Simple rules that cost little to run use
|
7921
8057
|
# fewer WCUs than more complex rules that use more processing power.
|
7922
8058
|
# Rule group capacity is fixed at creation, which helps users plan
|
7923
|
-
# their web ACL WCU usage when they use a rule group.
|
7924
|
-
#
|
8059
|
+
# their web ACL WCU usage when they use a rule group. For more
|
8060
|
+
# information, see [WAF web ACL capacity units (WCU)][1] in the *WAF
|
8061
|
+
# Developer Guide*.
|
8062
|
+
#
|
8063
|
+
#
|
8064
|
+
#
|
8065
|
+
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html
|
7925
8066
|
# @return [Integer]
|
7926
8067
|
#
|
7927
8068
|
# @!attribute [rw] pre_process_firewall_manager_rule_groups
|
@@ -7980,18 +8121,17 @@ module Aws::WAFV2
|
|
7980
8121
|
# rules and default actions that you define in the web ACL.
|
7981
8122
|
#
|
7982
8123
|
# For information about customizing web requests and responses, see
|
7983
|
-
# [Customizing web requests and responses in WAF][1] in the
|
7984
|
-
# Developer Guide
|
8124
|
+
# [Customizing web requests and responses in WAF][1] in the *WAF
|
8125
|
+
# Developer Guide*.
|
7985
8126
|
#
|
7986
8127
|
# For information about the limits on count and size for custom
|
7987
|
-
# request and response settings, see [WAF quotas][
|
7988
|
-
# Developer Guide
|
8128
|
+
# request and response settings, see [WAF quotas][2] in the *WAF
|
8129
|
+
# Developer Guide*.
|
7989
8130
|
#
|
7990
8131
|
#
|
7991
8132
|
#
|
7992
8133
|
# [1]: https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html
|
7993
|
-
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/
|
7994
|
-
# [3]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
8134
|
+
# [2]: https://docs.aws.amazon.com/waf/latest/developerguide/limits.html
|
7995
8135
|
# @return [Hash<String,Types::CustomResponseBody>]
|
7996
8136
|
#
|
7997
8137
|
# @!attribute [rw] captcha_config
|
@@ -8017,6 +8157,25 @@ module Aws::WAFV2
|
|
8017
8157
|
# domain list, including their prefixed subdomains.
|
8018
8158
|
# @return [Array<String>]
|
8019
8159
|
#
|
8160
|
+
# @!attribute [rw] association_config
|
8161
|
+
# Specifies custom configurations for the associations between the web
|
8162
|
+
# ACL and protected resources.
|
8163
|
+
#
|
8164
|
+
# Use this to customize the maximum size of the request body that your
|
8165
|
+
# protected CloudFront distributions forward to WAF for inspection.
|
8166
|
+
# The default is 16 KB (16,384 kilobytes).
|
8167
|
+
#
|
8168
|
+
# <note markdown="1"> You are charged additional fees when your protected resources
|
8169
|
+
# forward body sizes that are larger than the default. For more
|
8170
|
+
# information, see [WAF Pricing][1].
|
8171
|
+
#
|
8172
|
+
# </note>
|
8173
|
+
#
|
8174
|
+
#
|
8175
|
+
#
|
8176
|
+
# [1]: http://aws.amazon.com/waf/pricing/
|
8177
|
+
# @return [Types::AssociationConfig]
|
8178
|
+
#
|
8020
8179
|
# @see http://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/WebACL AWS API Documentation
|
8021
8180
|
#
|
8022
8181
|
class WebACL < Struct.new(
|
@@ -8035,7 +8194,8 @@ module Aws::WAFV2
|
|
8035
8194
|
:custom_response_bodies,
|
8036
8195
|
:captcha_config,
|
8037
8196
|
:challenge_config,
|
8038
|
-
:token_domains
|
8197
|
+
:token_domains,
|
8198
|
+
:association_config)
|
8039
8199
|
SENSITIVE = []
|
8040
8200
|
include Aws::Structure
|
8041
8201
|
end
|