@aws-sdk/client-wafv2 3.252.0 → 3.253.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.
@@ -458,6 +458,22 @@ export declare class WAFV2 extends WAFV2Client {
458
458
  * <p>Enables the specified <a>LoggingConfiguration</a>, to start logging from a
459
459
  * web ACL, according to the configuration provided. </p>
460
460
  * <note>
461
+ * <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>
462
+ * <p>To modify an existing logging configuration, do the following: </p>
463
+ * <ol>
464
+ * <li>
465
+ * <p>Retrieve it by calling <a>GetLoggingConfiguration</a>
466
+ * </p>
467
+ * </li>
468
+ * <li>
469
+ * <p>Update its settings as needed</p>
470
+ * </li>
471
+ * <li>
472
+ * <p>Provide the complete logging configuration specification to this call</p>
473
+ * </li>
474
+ * </ol>
475
+ * </note>
476
+ * <note>
461
477
  * <p>You can define one logging destination per web ACL.</p>
462
478
  * </note>
463
479
  * <p>You can access information about the traffic that WAF inspects using the following
@@ -482,9 +498,6 @@ export declare class WAFV2 extends WAFV2Client {
482
498
  * <p>For additional information about web ACL logging, see
483
499
  * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/logging.html">Logging web ACL traffic information</a>
484
500
  * in the <i>WAF Developer Guide</i>.</p>
485
- * <note>
486
- * <p>This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling <a>GetLoggingConfiguration</a>, update the settings as needed, and then provide the complete logging configuration specification to this call.</p>
487
- * </note>
488
501
  */
489
502
  putLoggingConfiguration(args: PutLoggingConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutLoggingConfigurationCommandOutput>;
490
503
  putLoggingConfiguration(args: PutLoggingConfigurationCommandInput, cb: (err: any, data?: PutLoggingConfigurationCommandOutput) => void): void;
@@ -553,7 +566,20 @@ export declare class WAFV2 extends WAFV2Client {
553
566
  /**
554
567
  * <p>Updates the specified <a>IPSet</a>. </p>
555
568
  * <note>
556
- * <p>This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling <a>GetIPSet</a>, update the settings as needed, and then provide the complete IP set specification to this call.</p>
569
+ * <p>This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. </p>
570
+ * <p>To modify an IP set, do the following: </p>
571
+ * <ol>
572
+ * <li>
573
+ * <p>Retrieve it by calling <a>GetIPSet</a>
574
+ * </p>
575
+ * </li>
576
+ * <li>
577
+ * <p>Update its settings as needed</p>
578
+ * </li>
579
+ * <li>
580
+ * <p>Provide the complete IP set specification to this call</p>
581
+ * </li>
582
+ * </ol>
557
583
  * </note>
558
584
  * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
559
585
  */
@@ -575,7 +601,20 @@ export declare class WAFV2 extends WAFV2Client {
575
601
  /**
576
602
  * <p>Updates the specified <a>RegexPatternSet</a>.</p>
577
603
  * <note>
578
- * <p>This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling <a>GetRegexPatternSet</a>, update the settings as needed, and then provide the complete regex pattern set specification to this call.</p>
604
+ * <p>This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. </p>
605
+ * <p>To modify a regex pattern set, do the following: </p>
606
+ * <ol>
607
+ * <li>
608
+ * <p>Retrieve it by calling <a>GetRegexPatternSet</a>
609
+ * </p>
610
+ * </li>
611
+ * <li>
612
+ * <p>Update its settings as needed</p>
613
+ * </li>
614
+ * <li>
615
+ * <p>Provide the complete regex pattern set specification to this call</p>
616
+ * </li>
617
+ * </ol>
579
618
  * </note>
580
619
  * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
581
620
  */
@@ -585,7 +624,20 @@ export declare class WAFV2 extends WAFV2Client {
585
624
  /**
586
625
  * <p>Updates the specified <a>RuleGroup</a>.</p>
587
626
  * <note>
588
- * <p>This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling <a>GetRuleGroup</a>, update the settings as needed, and then provide the complete rule group specification to this call.</p>
627
+ * <p>This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. </p>
628
+ * <p>To modify a rule group, do the following: </p>
629
+ * <ol>
630
+ * <li>
631
+ * <p>Retrieve it by calling <a>GetRuleGroup</a>
632
+ * </p>
633
+ * </li>
634
+ * <li>
635
+ * <p>Update its settings as needed</p>
636
+ * </li>
637
+ * <li>
638
+ * <p>Provide the complete rule group specification to this call</p>
639
+ * </li>
640
+ * </ol>
589
641
  * </note>
590
642
  * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
591
643
  * <p> A rule group defines a collection of rules to inspect and control web requests that you can use in a <a>WebACL</a>. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. </p>
@@ -596,10 +648,23 @@ export declare class WAFV2 extends WAFV2Client {
596
648
  /**
597
649
  * <p>Updates the specified <a>WebACL</a>. While updating a web ACL, WAF provides
598
650
  * continuous coverage to the resources that you have associated with the web ACL. </p>
599
- * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
600
651
  * <note>
601
- * <p>This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling <a>GetWebACL</a>, update the settings as needed, and then provide the complete web ACL specification to this call.</p>
652
+ * <p>This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. </p>
653
+ * <p>To modify a web ACL, do the following: </p>
654
+ * <ol>
655
+ * <li>
656
+ * <p>Retrieve it by calling <a>GetWebACL</a>
657
+ * </p>
658
+ * </li>
659
+ * <li>
660
+ * <p>Update its settings as needed</p>
661
+ * </li>
662
+ * <li>
663
+ * <p>Provide the complete web ACL specification to this call</p>
664
+ * </li>
665
+ * </ol>
602
666
  * </note>
667
+ * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
603
668
  * <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool. </p>
604
669
  */
605
670
  updateWebACL(args: UpdateWebACLCommandInput, options?: __HttpHandlerOptions): Promise<UpdateWebACLCommandOutput>;
@@ -11,6 +11,22 @@ export interface PutLoggingConfigurationCommandOutput extends PutLoggingConfigur
11
11
  * <p>Enables the specified <a>LoggingConfiguration</a>, to start logging from a
12
12
  * web ACL, according to the configuration provided. </p>
13
13
  * <note>
14
+ * <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>
15
+ * <p>To modify an existing logging configuration, do the following: </p>
16
+ * <ol>
17
+ * <li>
18
+ * <p>Retrieve it by calling <a>GetLoggingConfiguration</a>
19
+ * </p>
20
+ * </li>
21
+ * <li>
22
+ * <p>Update its settings as needed</p>
23
+ * </li>
24
+ * <li>
25
+ * <p>Provide the complete logging configuration specification to this call</p>
26
+ * </li>
27
+ * </ol>
28
+ * </note>
29
+ * <note>
14
30
  * <p>You can define one logging destination per web ACL.</p>
15
31
  * </note>
16
32
  * <p>You can access information about the traffic that WAF inspects using the following
@@ -35,9 +51,6 @@ export interface PutLoggingConfigurationCommandOutput extends PutLoggingConfigur
35
51
  * <p>For additional information about web ACL logging, see
36
52
  * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/logging.html">Logging web ACL traffic information</a>
37
53
  * in the <i>WAF Developer Guide</i>.</p>
38
- * <note>
39
- * <p>This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling <a>GetLoggingConfiguration</a>, update the settings as needed, and then provide the complete logging configuration specification to this call.</p>
40
- * </note>
41
54
  * @example
42
55
  * Use a bare-bones client and the command you need to make an API call.
43
56
  * ```javascript
@@ -10,7 +10,20 @@ export interface UpdateIPSetCommandOutput extends UpdateIPSetResponse, __Metadat
10
10
  /**
11
11
  * <p>Updates the specified <a>IPSet</a>. </p>
12
12
  * <note>
13
- * <p>This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling <a>GetIPSet</a>, update the settings as needed, and then provide the complete IP set specification to this call.</p>
13
+ * <p>This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. </p>
14
+ * <p>To modify an IP set, do the following: </p>
15
+ * <ol>
16
+ * <li>
17
+ * <p>Retrieve it by calling <a>GetIPSet</a>
18
+ * </p>
19
+ * </li>
20
+ * <li>
21
+ * <p>Update its settings as needed</p>
22
+ * </li>
23
+ * <li>
24
+ * <p>Provide the complete IP set specification to this call</p>
25
+ * </li>
26
+ * </ol>
14
27
  * </note>
15
28
  * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
16
29
  * @example
@@ -10,7 +10,20 @@ export interface UpdateRegexPatternSetCommandOutput extends UpdateRegexPatternSe
10
10
  /**
11
11
  * <p>Updates the specified <a>RegexPatternSet</a>.</p>
12
12
  * <note>
13
- * <p>This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling <a>GetRegexPatternSet</a>, update the settings as needed, and then provide the complete regex pattern set specification to this call.</p>
13
+ * <p>This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. </p>
14
+ * <p>To modify a regex pattern set, do the following: </p>
15
+ * <ol>
16
+ * <li>
17
+ * <p>Retrieve it by calling <a>GetRegexPatternSet</a>
18
+ * </p>
19
+ * </li>
20
+ * <li>
21
+ * <p>Update its settings as needed</p>
22
+ * </li>
23
+ * <li>
24
+ * <p>Provide the complete regex pattern set specification to this call</p>
25
+ * </li>
26
+ * </ol>
14
27
  * </note>
15
28
  * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
16
29
  * @example
@@ -10,7 +10,20 @@ export interface UpdateRuleGroupCommandOutput extends UpdateRuleGroupResponse, _
10
10
  /**
11
11
  * <p>Updates the specified <a>RuleGroup</a>.</p>
12
12
  * <note>
13
- * <p>This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling <a>GetRuleGroup</a>, update the settings as needed, and then provide the complete rule group specification to this call.</p>
13
+ * <p>This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. </p>
14
+ * <p>To modify a rule group, do the following: </p>
15
+ * <ol>
16
+ * <li>
17
+ * <p>Retrieve it by calling <a>GetRuleGroup</a>
18
+ * </p>
19
+ * </li>
20
+ * <li>
21
+ * <p>Update its settings as needed</p>
22
+ * </li>
23
+ * <li>
24
+ * <p>Provide the complete rule group specification to this call</p>
25
+ * </li>
26
+ * </ol>
14
27
  * </note>
15
28
  * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
16
29
  * <p> A rule group defines a collection of rules to inspect and control web requests that you can use in a <a>WebACL</a>. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. </p>
@@ -10,10 +10,23 @@ export interface UpdateWebACLCommandOutput extends UpdateWebACLResponse, __Metad
10
10
  /**
11
11
  * <p>Updates the specified <a>WebACL</a>. While updating a web ACL, WAF provides
12
12
  * continuous coverage to the resources that you have associated with the web ACL. </p>
13
- * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
14
13
  * <note>
15
- * <p>This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling <a>GetWebACL</a>, update the settings as needed, and then provide the complete web ACL specification to this call.</p>
14
+ * <p>This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. </p>
15
+ * <p>To modify a web ACL, do the following: </p>
16
+ * <ol>
17
+ * <li>
18
+ * <p>Retrieve it by calling <a>GetWebACL</a>
19
+ * </p>
20
+ * </li>
21
+ * <li>
22
+ * <p>Update its settings as needed</p>
23
+ * </li>
24
+ * <li>
25
+ * <p>Provide the complete web ACL specification to this call</p>
26
+ * </li>
27
+ * </ol>
16
28
  * </note>
29
+ * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
17
30
  * <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool. </p>
18
31
  * @example
19
32
  * Use a bare-bones client and the command you need to make an API call.
@@ -1995,9 +1995,9 @@ export interface VisibilityConfig {
1995
1995
  */
1996
1996
  CloudWatchMetricsEnabled: boolean | undefined;
1997
1997
  /**
1998
- * <p>A name of the Amazon CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9,
1998
+ * <p>A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9,
1999
1999
  * - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't
2000
- * contain whitespace or metric names reserved for WAF, for example <code>All</code> and
2000
+ * contain whitespace or metric names that are reserved for WAF, for example <code>All</code> and
2001
2001
  * <code>Default_Action</code>. </p>
2002
2002
  */
2003
2003
  MetricName: string | undefined;
@@ -3395,7 +3395,7 @@ export interface GetSampledRequestsRequest {
3395
3395
  */
3396
3396
  WebAclArn: string | undefined;
3397
3397
  /**
3398
- * <p>The metric name assigned to the <code>Rule</code> or <code>RuleGroup</code> for which
3398
+ * <p>The metric name assigned to the <code>Rule</code> or <code>RuleGroup</code> dimension for which
3399
3399
  * you want a sample of requests.</p>
3400
3400
  */
3401
3401
  RuleMetricName: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-wafv2",
3
3
  "description": "AWS SDK for JavaScript Wafv2 Client for Node.js, Browser and React Native",
4
- "version": "3.252.0",
4
+ "version": "3.253.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",